From 0d5fbe5a1ad4a6402e32fa577720bc41cd2016d2 Mon Sep 17 00:00:00 2001 From: Kamran Ahmed Date: Thu, 30 Aug 2018 23:13:12 +0500 Subject: Add license and remove webnavigation permission --- README.md | 54 ---------------------------------------------------- license.md | 21 ++++++++++++++++++++ public/manifest.json | 1 - readme.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 75 insertions(+), 55 deletions(-) delete mode 100644 README.md create mode 100644 license.md create mode 100644 readme.md diff --git a/README.md b/README.md deleted file mode 100644 index 1906eba..0000000 --- a/README.md +++ /dev/null @@ -1,54 +0,0 @@ -

- Githunt
GitHunt -

- -

- - contributions - - - version - - - license-mit - -

- -

- Hunt the most starred projects on GitHub
- ✨ React app and Chrome Extension to go through the top projects ✨ -

- -
- -Whenever you will open a new tab, you will be presented with a page similar to following - -![New Tab](http://i.imgur.com/COyJUJg.png) - -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. - -![Options Page](http://i.imgur.com/FK1vFlq.png) - -- 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) - -## License -MIT © [Kamran Ahmed](https://kamranahmed.info) diff --git a/license.md b/license.md new file mode 100644 index 0000000..a0383ae --- /dev/null +++ b/license.md @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2018 Kamran Ahmed + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/public/manifest.json b/public/manifest.json index 137520a..c64eafb 100644 --- a/public/manifest.json +++ b/public/manifest.json @@ -7,7 +7,6 @@ "permissions": [ "tabs", "storage", - "webNavigation", "*://*.github.com/*" ], "icons": { diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..1906eba --- /dev/null +++ b/readme.md @@ -0,0 +1,54 @@ +

+ Githunt
GitHunt +

+ +

+ + contributions + + + version + + + license-mit + +

+ +

+ Hunt the most starred projects on GitHub
+ ✨ React app and Chrome Extension to go through the top projects ✨ +

+ +
+ +Whenever you will open a new tab, you will be presented with a page similar to following + +![New Tab](http://i.imgur.com/COyJUJg.png) + +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. + +![Options Page](http://i.imgur.com/FK1vFlq.png) + +- 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) + +## License +MIT © [Kamran Ahmed](https://kamranahmed.info) -- cgit v1.3