diff --git a/README.md b/README.md index 1333ed7..1eecf5a 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ -TODO +# Neon Vertigo + +This is a repository for the "shared" data of the Neon Vertigo project. +It contains shared configuration files and docs. + +## Disclaimer + +This project has no real goal other than learning and self-improvement. +It is not production ready and may not ever be production ready. +Authors assume no responsibility over the consequences of deploying +this code anywhere. + +Other than that, feel free to look and explore. + +## Components +- [Frontend app, made in Astro;](https://git.artemis-grove.me/neon-vertigo/web) +- [API layer, made in Scala with Play;](https://git.artemis-grove.me/neon-vertigo/api) +- [Service layer for processing bids, made in Elixir;](https://git.artemis-grove.me/neon-vertigo/service)