Skip to content

ShuchirJ/readme-map

Repository files navigation

readme-map

A Github README plugin to generate map-data based on profile visits!

image

Features

  • Light/dark mode
  • Top 5 regions
  • Highlighted map with all country visits

Usage

  1. Add the following to your README:
    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;
    Map of my profile visits t;Map of my profile visits" /> a>" tabindex="0" role="button">
    (or alternatively, use ?theme=light for light mode)
  2. Replace USERNAME_HERE with your GitHub username.
  3. Visit https://readme-map.shuchir.dev/add/USERNAME_HERE so readme-map has some data to generate a map from.
  4. Deploy the action workflow in actions_template.yml to your repository.
  5. Run the workflow to generate the initial map.

Self-Hosting

  1. Clone the repository:
    git clone https://github.com/ShuchirJ/readme-map.git
  2. Install the dependencies:
    pip install -r requirements.txt
  3. Run the app:
    python main.py

Releases

No releases published

Packages

No packages published

Languages