SkyID
/
GitCodeTree
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update read me

This commit is contained in:
Buu Nguyen 2014-05-13 23:35:58 -07:00
parent 5f5529e75c
commit edae3208b2
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,17 +1,23 @@
## Octotree
Chrome extension to display GitHub code in tree format. Useful for developers who frequently read source in GitHub and do not want to download or checkout too many repositories. Features:
Browser extensions (Chrome, Firefox and Safari) to display GitHub code in tree format. Useful for developers who frequently read source in GitHub and do not want to download or checkout too many repositories. Features:
* Easy-to-navigate code tree like IDEs
* Fast browsing with pjax
* Support private repositories (require [personal access token](#github-api-rate-limit))
## Install
## Install on Chrome
* Download and install [Octotree](https://chrome.google.com/webstore/detail/octotree/bkhaagjahfmjljalopjnoealnfndnagc) from the Chrome store
* Navigate to any GitHub project (or just refresh this page as an example)
* The code tree should show as follows:
![When extension is active](https://raw.githubusercontent.com/buunguyen/octotree/master/docs/chrome.png)
## Install on Firefox and Safari
I'm in the process of submitting the extensions to Mozilla and Safari stores. Meanwhile, you can install the prebuilt extensions located in the [dist](https://github.com/buunguyen/octotree/tree/master/dist) folder.
* Firefox: drag `octotree.xpi` to the browser and follow the instructions
* Safari: drag `octotree.safariextz` to the browser and follow the instructions
## GitHub API Rate Limit
Octotree uses [GitHub API](https://developer.github.com/v3/) to retrieve repository metadata. By default, it makes unauthenticated requests to the GitHub API. However, there are two situations when requests must be authenticated:
@ -27,7 +33,7 @@ If you don't already have one, create one at [this page](https://github.com/sett
Alternatively, you can always manually enter or update the token by following these steps:
* Navigate to any GitHub page
* Open the Chrome developer console
* Open the Chrome (or Safari, Firefox) developer console
* Execute the following line:
```javascript
localStorage.setItem('octotree.github_access_token', JSON.stringify('REPLACE WITH TOKEN'))
@ -44,4 +50,5 @@ There are several improvements that can be made to Octotree. Contribution is ver
- [ ] Show progress indicator while the code tree or a file is being loaded (with Pjax). (Showing spinner in the toggle button?)
## Credit
[Icon](https://github.com/pstadler/octofolders) by [pstadler](https://github.com/pstadler)
* [Icon](https://github.com/pstadler/octofolders) by [pstadler](https://github.com/pstadler)
* Thanks to many people submitting pull requests, reporting bugs and suggesting ideas here and on [HN](https://news.ycombinator.com/item?id=7740226)