Added example readme

README.md

@@ -1,15 +1,11 @@
 # protostar
 
-Prototype application launcher
+Prototype application launcher for StardustXR
 
-TODO:
+Protostar provides an easy to use crate to write applications launchers. See the [examples](examples) to learn more!
 
-1) ~~Make it work with all icons (should be done)~~
+# TODO:
 
-2. ~~If the right sized png exists, then use that, otherwise rasterize it (a bit janky but it works)~~
+1. Implement our own (more reliable) way to get icons
-3. ~~Use XDG_CACHE_DIR to rasterize svgs (done)~~
+2. Untangle the code (eg: make it so that the user can decide sizes, models, etc... ) 
-4. Make sure it's using the current icon theme
+3. Implement [configuration files](https://docs.rs/confy/latest/confy/) in the examples
-5. Design a better app launcher ui
-
-TO RUN DOCK
-cargo run --example sirius

examples/README.md

@@ -0,0 +1,8 @@
+# Running the examples:
+
+```
+cargo run --example=sirius
+cargo run --example=app_grid
+cargo run --example=hexagon_launcher
+
+```