docs: write up readme

urbanSpatial · May 1, 2021 · dcd42fe · dcd42fe
1 parent 39a0bf6
commit dcd42fe
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,4 +1,25 @@
 # LetsPlan.org
 
-This repository is used for developing the LetsPlan.org application.
+A tool for neighbors to learn from about their RCO with open data and engage in community planning.
 
+## Documentation
+
+See this repository's GitHub Pages website for documentation automatically build from the `docs/` directory: <https://urbanspatial.github.io/LetsPlanOrg>
+
+## Technology components
+
+- Laravel backend
+- Vue frontend
+- Mapbox GL vector map
+- Kubernetes deployment via Helm
+- GitHub Actions build automation
+
+## Screenshots
+
+### Sale price indicator
+
+![Sale price indicator](./screenshots/sale-price.gif)
+
+### Other indicators
+
+![Other indicator](./screenshots/indicators.gif)
diff --git a/screenshots/indicators.gif b/screenshots/indicators.gif
diff --git a/screenshots/sale-price.gif b/screenshots/sale-price.gif