-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add getting-started steps to README
- Loading branch information
Showing
1 changed file
with
12 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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! |