X-Git-Url: https://git.r.bdr.sh/rbdr/serpentity-lib/blobdiff_plain/8d90115ac567adb5a3c61eefd27ab675fb3c0ef7..582cea2aedd3b5763232837cc4960f07223908fb:/components/velocity/README.md

diff --git a/components/velocity/README.md b/components/velocity/README.md
new file mode 100644
index 0000000..bb9d0b6
--- /dev/null
+++ b/components/velocity/README.md
@@ -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