Update README

.env.example

@@ -1,3 +1,6 @@
-VITE_URL_API_URL=             # API Endpoint
-VITE_GOOGLE_MAP_KEY=          # Map ID associated with the maps key in Google Cloud
-VITE_RECAPTCHA_SITE_KEY=      # Recaptcha Site Key
+VITE_GOOGLE_MAP_KEY=
+VITE_RECAPTCHA_SITE_KEY=
+VITE_DATABASE_URL=
+VITE_DATABASE_KEY=
+VITE_SLACK_NEW_CANDIDATE_URL=
+VITE_SLACK_REPORT_URL=

README.md

@@ -1,31 +1,49 @@
-<img src="./docs/background.png" alt="Nimiq Crypto Map banner" />
-
-# Crypto Nimiq Map
-
-A map of the crypto world, powered by Nimiq.
-
-## Environment Variables
-
-Duplicate `.env.example` and rename it to `.env`. Then fill in the values.
-
-```bash
-VITE_API_URL=             # API Endpoint
-VITE_GOOGLE_MAP_KEY=          # Map ID associated with the maps key in Google Cloud
-VITE_RECAPTCHA_SITE_KEY=      # Recaptcha Site Key
-```
-
-## Project Setup
-
-```sh
-npm install
-
-yarn install
-```
-
-### Compile and Hot-Reload for Development
-
-```sh
-npm run dev
-
-yarn dev
-```
+<br />
+<p align="center">
+  <a href="https://github.com/nimiq/crypto-map">
+    <img src="./public/logo.svg" alt="Logo" width="130" />
+  </a>
+
+<h1 align="center">
+Nimiq's Crypto Map
+</h1>
+<p align="center">
+The Crypto Map by Nimiq.<br>
+Explore the world and find places to spend your crypto.
+<p>
+
+<p align="center">
+<a href="https://map.nimiq.com/" target="__blank"><img src="https://img.shields.io/badge/Locations-2000-blue?style=flat&colorA=002438&colorB=41c399" alt="Locations"></a>
+<a href="https://map.nimiq.com/" target="__blank"><img src="https://img.shields.io/badge/Cryptos-12-blue?style=flat&colorA=002438&colorB=41c399" alt="Cryptos"></a>
+<a href="https://map.nimiq.com/" target="__blank"><img src="https://img.shields.io/badge/Providers-6-blue?style=flat&colorA=002438&colorB=41c399" alt="Providers"></a>
+</p>
+
+<p align="center">
+<a href="https://t.me/joinchat/AAAAAEJW-ozFwo7Er9jpHw"><b>Get involved!</b></a>
+</p>
+<p align="center">
+ <a href="https://map.nimiq.com/">Crypto Map</a> | <a href="https://wallet.nimiq.com">Wallet</a> | <a href="https://cpl.com">Cryptopayment Link</a> 
+</p>
+
+
+## Contributing
+
+All PRs all welcomed! Join our [Telegram](https://t.me/joinchat/AAAAAEJW-ozFwo7Er9jpHw) and we will get you up and running!
+
+## Dev Setup
+
+> [!IMPORTANT]  
+> You need to have a valid `.env` file in the root of the project.
+
+1. Clone the repo
+2. Run `pnpm i`
+3. Or run `pnpm dev` to run the app
+4. Run `pnpm story:dev` to run histoire
+
+## 🏗️ Stack
+
+- [Vue](https://vuejs.org/) An approachable, performant and versatile framework for building web user interfaces.
+- [VueUse](https://vueuse.org/) Collection of Essential Vue Composition Utilities
+- [Radix UI](https://radix-vue.com) for porting Radix UI to Vue
+- [GMaps](https://developers.google.com/maps) Build awesome apps with Google’s knowledge of the real world
+- [Tailwind](https://tailwindcss.com/) A utility-first CSS framework for rapid UI development.