Skip to content

Commit

Permalink
docs: add getting-started steps to README
Browse files Browse the repository at this point in the history
  • Loading branch information
iShibi committed Sep 8, 2024
1 parent 7e791fd commit 66febb1
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# Leet2Hub

A browser extension that uploads LeetCode submissions to GitHub.

### Get Started

1. Create a new repository on GitHub.
2. [Create a Github Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) with the following permission for the repository:

"Contents" repository permissions (read/write)

3. Download the extension from [Releases](https://github.com/iShibi/leet2hub/releases).
4. Unzip the extension and load it on the browser.
5. Go to extension options page to add Github PAT and repository link.
6. THAT'S IT!

0 comments on commit 66febb1

Please sign in to comment.