Skip to content

Commit

Permalink
docs: add getting started instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
AttackOnMorty committed May 1, 2024
1 parent ec83088 commit dd9c4b6
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,10 @@
Compare GitHub repos by the history of stars, issues, releases...

![CleanShot 2023-12-22 at 12 27 29@2x](https://github.com/AttackOnMorty/github-trends/assets/37203901/35f5ceb2-3378-45f4-ab36-ff139043e809)

## Getting Started

1. Clone repo
2. Copy `.env.example` to `.env`
3. Get a personal access token from GitHub and add it to `.env`
4. Run `npm install && npm start`

0 comments on commit dd9c4b6

Please sign in to comment.