Add license and more readme

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 igloo-4002
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,25 +1,48 @@
 # Urban Flo
 
+![CI Status](https://img.shields.io/github/actions/workflow/status/igloo-4002/urbanflo-vite/ci.yml?style=flat-square) 
+![Licence badge](https://img.shields.io/github/license/igloo-4002/urbanflo-vite?style=flat-square)
+
+![UrbanFlo Logo](docs/images/urbanflo-logo.png)
+
 Urban Flo allows users to model traffic networks, run simulations and
 collect information on the networks efficiency.
 
-### Development
+## Features
+
+- Backed by [SUMO](https://sumo.dlr.de) simulation engine
+- 100% web based - no need for complicated installation
+- Simulation statistics
+- Save and load your network to your device at any time
+- Free and open source (MIT licensed)
+
+## Screenshots
+
+Simulation UI:
+
+![Simulation UI](docs/images/simulation.png)
+
+Simulation statistics:
+
+![Simulation statistics](docs/images/statistics.png)
+
+## Development
 
 To start development on Urban Flo
 
-#### Install Dependencies
+### Install Dependencies
 
 ```bash
 pnpm install
 ```
 
-#### To run the application
+### To run the application
 
 ```bash
 pnpm dev
 ```
 
-#### Connecting to the SUMO server
+### Connecting to the SUMO server
 
 A developer has two options, either to connect and run simulations on the cloud server running on `sumo-server.urbanflo.app` or run the server locally.
 
@@ -28,5 +51,9 @@ To run the server locally, follow the instructions in the [server's repository](
 ## Contributors
 
 <a href = "https://github.com/igloo-4002/urbanflo-vite/graphs/contributors">
-  <img src = "https://contrib.rocks/image?repo=igloo-4002/urbanflo-vite"/>
+  <img alt="UrbanFlo contributors" src = "https://contrib.rocks/image?repo=igloo-4002/urbanflo-vite"/>
 </a>
+
+## Licence
+
+Licensed under [MIT License](LICENSE.txt).