A Github README plugin to generate map-data based on profile visits!
- Light/dark mode
- Top 5 regions
- Highlighted map with all country visits
- Add the following to your README:
(or alternatively, use
a href="https://readme-map.shuchir.dev/add/USERNAME_HERE" target="_blank">gt; img src="https://readme-map.shuchir.dev/map/?theme=dark" alt="Map of my profile visits" />gt; a>gt; t;Map of my profile visits" /> a>" tabindex="0" role="button">
?theme=lightfor light mode) - Replace
USERNAME_HEREwith your GitHub username. - Visit https://readme-map.shuchir.dev/add/USERNAME_HERE so readme-map has some data to generate a map from.
- Deploy the action workflow in actions_template.yml to your repository.
- Run the workflow to generate the initial map.
- Clone the repository:
git clone https://github.com/ShuchirJ/readme-map.git
- Install the dependencies:
pip install -r requirements.txt
- Run the app:
python main.py