diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 28ed42a..90fa145 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,4 +14,4 @@ ### Do you have an idea or feature request? -- Use the discussion space above or reach out through email: contact[at]intuitem.com to see how we can help each other in an optimal way +- Use the discussion space above or reach out through email: contact[at]intuitem.com to see how we can help each other in an optimal way \ No newline at end of file diff --git a/mira_overview.png b/mira_overview.png new file mode 100644 index 0000000..2806165 Binary files /dev/null and b/mira_overview.png differ diff --git a/readme.md b/readme.md index 09378ed..4210c33 100644 --- a/readme.md +++ b/readme.md @@ -3,8 +3,18 @@ MIRA is your streamlined one-stop shop for risk assessment and management. What makes it special is the fact that it is based on field knowledge and inputs from security experts. +## Overview + +![mira overview](mira_overview.png) + +## Community + +Join our [open Discord community](https://discord.gg/7ubENCPF) to interact with the team and other GRC experts. + ## Installation +> The fastest and easiest way to get started is through the [free trial of cloud instance available here](https://intuitem.com/trial). + This part is divided in two sections, the quick start if you simply want to run MIRA to see what it's made of, and the development setup if you want to go further. ### Requirements @@ -18,7 +28,7 @@ To install gettext and pango, do `sudo apt update && sudo apt install gettext li ### Quick start 🏁 -There are two methods to run MIRA in a quick way, using Python or using Docker. +There are two methods to run MIRA locally: using Python or using Docker. By default, Django secret key is generated randomly at each start of Mira. This is convenient for quick test, but not recommended for production, as it can break the sessions (see this [topic](https://stackoverflow.com/questions/15170637/effects-of-changing-djangos-secret-key) for more information). To set a fixed secret key, use the environment variable DJANGO_SECRET_KEY.