diff options
| author | Kamran Ahmed <kamranahmed.se@gmail.com> | 2018-08-30 23:36:51 +0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-08-30 23:36:51 +0500 |
| commit | 5c46fe95d331fc9502091e23dc8ca2f2724ee7ca (patch) | |
| tree | d1d27f560d0e29c14c2fe6f9a3b04b05636071a3 | |
| parent | Update versio in manifest (diff) | |
| download | githunt-5c46fe95d331fc9502091e23dc8ca2f2724ee7ca.tar.gz | |
Update readme.md
| -rw-r--r-- | readme.md | 33 |
1 files changed, 9 insertions, 24 deletions
@@ -21,34 +21,19 @@ <br /> -Whenever you will open a new tab, you will be presented with a page similar to following +* **Web application**: React application which you can use as a [Web Application](http://kamranahmed.info/githunt) +* **Extension**: [chrome extension](https://chrome.google.com/webstore/detail/githunt/khpcnaokfebphakjgdgpinmglconplhp) to replace your new tab with the trending repositories +* **Dates**: view the trending list on any day, month, week or year in past +* **Languages**: filter the repositories by language of your choice +* **Views**: use the grid or listing, whatever you like +* **Remembers**: it remembers the options you select and will present - - -By default it is set to show the trending repositories from the current week plus the repositories belonging to every language shown. However, once you will apply some filter, it will remember your configuration and the next time you will open the new tab, you will be presented with the last filter that you applied. + ## Installation -Extension itself doesn't need any setup. All you have to do is - -- Install it from [Chrome Webstore](https://chrome.google.com/webstore/detail/githunt/khpcnaokfebphakjgdgpinmglconplhp) or [manually install it](http://superuser.com/a/247654/6877). - - -Github API has rate limit applied in their API and although the extension implements the caching in order to make sure that the rate limit may not be crossed, however I would recommend you to set the API token in the extension in order to increase the quota. - -Here is how you can do that - -- Go to the [`Settings > Personal Access Tokens`](https://github.com/settings/tokens) of your github profile -- Click `Generate New Token` button. Give the token description and select the scope called `public_repo` under `repo` and click `Generate Token`. -- You will be presented with the generated token. Copy the token. -- Right click on the extension icon and click `Options`. Paste the API token in the given field and click save. - - - -- Voila! You are all set to go on a hunt. - -## Contribution -I'd love to hear what you have to say. Reach me out at kamranahmed.se@gmail.com or on twitter [@kamranahmedse](http://twitter.com/kamranahmedse) +* Use Online – http://kamranahmed.info/githunt +* Chrome Extension – http://bit.ly/githunt-chrome ## License MIT © [Kamran Ahmed](https://kamranahmed.info) |