]> git.r.bdr.sh - rbdr/serpentity-lib/blobdiff - components/velocity/README.md
Transfer components to lib repo
[rbdr/serpentity-lib] / components / velocity / README.md
diff --git a/components/velocity/README.md b/components/velocity/README.md
new file mode 100644 (file)
index 0000000..bb9d0b6
--- /dev/null
@@ -0,0 +1,11 @@
+# Velocity Component for Serpentity
+
+This is a component for [serpentity][serpentity], it holds the following values:
+
+```
+-x <Number> // the x component of velocity vector
+-y <Number> // the y component of velocity vector
+-z <Number> // the z component of velocity vector
+```
+
+[serpentity]: https://gitlab.com/serpentity/serpentity