update readme.md

Readme.md

@@ -1,16 +1,24 @@
 # Introduction
 
-![Build Status](https://circleci.com/gh/dnutiu/retroactiune.svg?style=svg)
+![Build Status](https://circleci.com/gh/dnutiu/retroactiune.svg?style=svg) 
 
-The following project uses ASP .Net Core 3.1
+![Swagger API](./docs/retroactiune_swagger.png)
+
+Retroactiune is a project for managing Feedback. It works in the following way,
+an Admin to creates FeedbackReceivers that will receive Feedback. Then it will generate Tokens that can be 
+distributed to the users. A Tokens is bound to a single FeedbackReceiver and it's a one time use for giving Feedback.
+
+The given Feedback is anonymous by design.
+
+## Tech Stack
+
+The project uses ASP .Net Core 3.1 and [MongoDB](https://www.mongodb.com/).
 
 ```bash
 dotnet --version
 3.1.407
 ```
 
-This is a side project and it's still work in progress, therefore the lack of documentation. The goal is to create a Web Application for managing Feedback.
-
 ## Architecture
 
 Example deployment architecture which uses [Prometheus](https://prometheus.io/) & [Grafana](https://grafana.com/) for monitoring, [Auth0](https://auth0.com/) as a authorization server
@@ -21,3 +29,23 @@ and [Sentry](https://sentry.io/welcome/) for error reporting.
 The application code is organized using the [Clean Architecture](https://docs.microsoft.com/en-us/dotnet/architecture/modern-web-apps-azure/common-web-application-architectures#clean-architecture) approach.
 
 ![Example deployment architecture](./docs/app_architecture_layers.png)
+
+## Developing
+
+
+To install the dependencies run `dotnet restore`.
+
+To run the project run
+
+```bash
+dotnet run --project .\Retroactiune.WebAPI\
+```
+
+To run unit and integration tests run:
+
+_Note: [Docker](https://www.docker.com/) and [Docker-Compose](https://docs.docker.com/compose/) are needed to bring up the dependent services, see `docker-compose.yaml`._
+
+```bash
+docker-compose up -d
+dotnet test
+```