Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hzoo authored Feb 21, 2021
1 parent deaf2b6 commit fbae1bf
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,17 @@ Much thanks to @Pocket-titan and @djrosenbaum for working on the logo 🖼!

---

## Install

[link-chrome]: https://chrome.google.com/webstore/detail/github-contributor-stats/cjbacdldhllelehomkmlniifaojgaeph?hl=en 'Version published on Chrome Web Store'
[link-firefox]: https://addons.mozilla.org/en-US/firefox/addon/contributor-on-github/ 'Version published on Mozilla Add-ons'

[<img src="https://raw.githubusercontent.com/alrra/browser-logos/main/src/chrome/chrome_128x128.png" width="48" alt="Chrome" valign="middle">][link-chrome] [<img valign="middle" src="https://img.shields.io/chrome-web-store/v/cjbacdldhllelehomkmlniifaojgaeph.svg?label=%20">][link-chrome] also compatible with [<img src="https://raw.githubusercontent.com/alrra/browser-logos/main/src/edge/edge_48x48.png" width="24" alt="Edge" valign="middle">][link-chrome] [<img src="https://raw.githubusercontent.com/alrra/browser-logos/main/src/opera/opera_48x48.png" width="24" alt="Opera" valign="middle">][link-chrome]

[<img src="https://raw.githubusercontent.com/alrra/browser-logos/main/src/firefox/firefox_128x128.png" width="48" alt="Firefox" valign="middle">][link-firefox] [<img valign="middle" src="https://img.shields.io/amo/v/refined-github-.svg?label=%20">][link-firefox] (waiting for approval!!)

This comment has been minimized.

Copy link
@fregante

fregante Feb 22, 2021

Contributor

Neat! Glad you like the style and release workflow 🙌


---

## Usage

You can start from any page on `github.com` and when you navigate to a specific issue/pull request (such as https://github.com/babel/babel/pull/3331), it will inject information inline (like the # of PRs a user has made to that specific repo).
Expand All @@ -32,19 +43,12 @@ If necessary, you may want to create or get a "access token" that uses the `publ

- "https://github.com/*/*": to be able to inject data into github
- The [content script](src/content.js) was matching `"https://github.com/*/*/pull/*` which is correct, but if you start from the hompage, then the script won't ever be injected since github is using pushState to change urls. Now it will match `https://github.com` and then check for the specific url.
- "storage", to store access token, cache user PR data.
- "identity", to create an oauth request window.
- "https://api.github.com/*": to fetch issue/pr data
- `"storage"`, to store access token, cache user PR data.
- `"identity"`, to create an oauth request window.

---

## Install

> I would recommend installing locally to try new features first (it's easy to update/revert/modify yourself) by just `git pull`.
- [Chrome extension](https://chrome.google.com/webstore/detail/github-contributor-stats/cjbacdldhllelehomkmlniifaojgaeph?hl=en)

---

## Local Install (Chrome)

- Download the zip, and unzip it
Expand All @@ -66,14 +70,13 @@ Now try it out!

---

## References
## Related

- https://github.com/GoogleChrome/chrome-app-samples/tree/master/samples/github-auth
- https://github.com/sindresorhus/notifier-for-github-chrome
- [Awesome browser extensions for GitHub](https://github.com/stefanbuck/awesome-browser-extensions-for-github)
- [Refined GitHub](https://github.com/sindresorhus/refined-github/) - OG github extension

---

## License

MIT

0 comments on commit fbae1bf

Please sign in to comment.