xyvs/wakapi-readme-stats
1
0
Fork 0
Code Issues 2 Pull Requests 1 Actions Packages Projects Releases 1 Wiki Activity

Update README.md

Browse Source 
Improved some English and styling
This commit is contained in:
Aaron Meese
2020-08-06 10:33:58 -05:00
committed by GitHub
parent 3f60e55a2a
commit 80a0a4ee1f
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -42,12 +42,12 @@
2. You'll need a WakaTime API Key. You can get that from your WakaTime Account Settings 2. You'll need a WakaTime API Key. You can get that from your WakaTime Account Settings
- You can refer [here](#new-to-wakatime), if you're new to WakaTime - You can refer [here](#new-to-wakatime), if you're new to WakaTime
3. You'll need a GitHub API Token with `repo` and `user` scope from [here](https://github.com/settings/tokens) if you're running the action to get commit metrics 3. You'll need a GitHub API Token with `repo` and `user` scope from [here](https://github.com/settings/tokens) if you're running the action to get commit metrics
> enable `repo` scope seems **DANGEROUS**<br/> > enabling the `repo` scope seems **DANGEROUS**<br/>
> but this GitHub Action only accesses your commit timestamp and lines of code added or deleted in repository you contributed. > but this GitHub Action only accesses your commit timestamp and lines of code added or deleted in repository you contributed.
- You can use [this](#profile-repository) example to work it out - You can use [this](#profile-repository) example to work it out
4. You need to save the WakaTime API Key and the GitHub API Token in the repository secrets. You can find that in the Settings of your Repository.Be sure to save those as the following. 4. You need to save the WakaTime API Key and the GitHub API Token in the repository secrets. You can find that in the Settings of your repository. Be sure to save those as the following.
- WakaTime-api-key as `WAKATIME_API_KEY = <your wakatime API Key>`and - WakaTime API Key as `WAKATIME_API_KEY=<your wakatime API Key>`
- The GitHub Access Token as `GH_TOKEN=<your github access token>` - GitHub Personal Access Token as `GH_TOKEN=<your github access token>`
5. You can enable and disable feature flags based on requirements. 5. You can enable and disable feature flags based on requirements.
@@ -314,7 +314,7 @@ Contributions are welcome! ♥! Please share any features, and add unit tests! U
</details> </details>
- And you! If ever you are using it right now and you are not on the list please tell us by sending a special mention issue [Special Mention](https://github.com/anmol098/waka-readme-stats/issues/new/choose) :blush: we are glad to add you in the list. - And you! If ever you are using it right now and you are not on the list please tell us by sending a [Special Mention](https://github.com/anmol098/waka-readme-stats/issues/new/choose) issue :blush: we are glad to add you in the list.
Made with :heart: and Python 🐍. Made with :heart: and Python 🐍.