diff --git a/README.md b/README.md index a800427..4cf3f34 100644 --- a/README.md +++ b/README.md @@ -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!