Add README.md

lyra-ecs/README.md

@@ -0,0 +1,25 @@
+# Lyra ECS
+An ECS for the Lyra game engine.
+
+## Why does it exist?
+I couldn't find anything that fulfilled my needs, specifically an ECS that can store arbitrary components without knowing about the types. This makes it easier to implement into a scripting engine that has the ability to create its own components.
+
+## Features
+- [ ] Archetypes
+  - [x] Spawning entities
+  - [ ] Despawning entities
+    - [ ] Delete entities from archetypes
+    - [ ] Find some way to fill in the gaps in component columns after entities are deleted
+  - [ ] Grow archetype as it fills up
+- [ ] Querying components from archetypes
+  - [x] Views
+  - [ ] Mutable views
+- [ ] Resources
+- [ ] Relationships (maybe this can be done through queries, idk)
+- [ ] Dynamic queries
+    * Needed for scripting engines that can create their own components that Rust does not know the types of.
+- [ ] Systems
+  - [ ] Dispatchers/Executors
+
+
+To be honest, the name may change at some point