GitCodeTree/README.md

## Octotree
Browser extensions (Chrome, Firefox, Safari and Opera) 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
* Customizable hotkey
* Support private repositories (see [instructions](#github-access-token))
* Support GitHub Enterprise (Chrome and Opera only, see [instructions](#github-enterprise))

## Install on Chrome and Firefox
* Download and install Octotree from [Chrome Web Store](https://chrome.google.com/webstore/detail/octotree/bkhaagjahfmjljalopjnoealnfndnagc) or [Mozilla Add-ons Store](https://addons.mozilla.org/en-US/firefox/addon/octotree/)
* Navigate to any GitHub repository (or just refresh this page as an example)
* The code tree should show on the left-hand side of the screen

## Install on Safari and Opera
You can install the prebuilt extensions located in the [dist](https://github.com/buunguyen/octotree/tree/master/dist) folder. For security reason, only download Octotree from this location.

* Safari: drag `safari.safariextz` to the browser and follow the instructions
* Opera: drag `opera.nex` to the browser and follow the instructions

## GitHub access token
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:

* You access a private repository
* You exceed the [rate limit of unauthenticated requests](https://developer.github.com/v3/#rate-limiting)

When that happens, Octotree will ask for your [GitHub personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use). If you don't already have one, [create one](https://github.com/settings/tokens/new), then copy and paste it into the textbox. Note that the minimal scopes that should be granted are `public_repo` and `repo` (if you need access to private repositories).

Alternatively, you can manually enter or update the token by following these steps:

* Navigate to any GitHub repository
* Open the Chrome (or Safari, Firefox) developer console
* Execute the following line:
```javascript
localStorage.setItem('octotree.github_access_token', 'REPLACE WITH TOKEN')
```

Note: if you use GitHub Enterprise, each site will need its own access token. Therefore, Octotree stores access token on a per-site basis.


## GitHub Enterprise
By default, Octotree only works on `github.com`. To support GitHub Enterprise on Chrome or Opera, you must grant Octotoree sufficient permissions. Follow these steps to do so:

* Navigate to any GitHub repository on `github.com`
* Open Octotree's setting panel
* Fill in the GitHub Enterprise URLs textbox, one site URL per line
* Click Save and accept any permission prompt
* Navigate to your GitHub Enterprise site (or refresh if you're already in one)
* You might be asked to create an [access token](#github-access-token)


## Changelog

### [v1.4.1](https://github.com/buunguyen/octotree/issues?q=milestone%3A1.4.1+is%3Aclosed)
* New header to match new GitHub design
* Bug fixes

### [v1.4](https://github.com/buunguyen/octotree/issues?labels=&milestone=4&page=1&state=closed)
* Support GitHub enterprise
* Change default hotkey (`cmd+b` for Safari and `cmd+shift+s` for all other browsers)
* Some other minor changes

### [v1.3](https://github.com/buunguyen/octotree/issues?labels=&milestone=3&page=1&state=closed)
* Setting panel allowing:
 * Changing access token
 * Changing hotkeys
 * Changing sidebar default visibility
 * Changing folder collapsing option
* Sidebar appears better in large monitors
* More responsive in big repositories
* And bug fixes

### [v1.2](https://github.com/buunguyen/octotree/issues?labels=&milestone=1&page=1&state=closed)
* Hide sidebar by default (upon many user requests)
* Hotkey (`cmd+b`, `ctrl+b`) to toggle sidebar
* Sidebar is now resizable
* Support rendering submodules
* Reflect GitHub selection to Octotree
* New sidebar header and progress indicator
* And bug fixes

### [v1.1](https://github.com/buunguyen/octotree/issues?labels=&milestone=2&page=1&state=closed)
* New UI that blends better with GitHub!
* Hide Octotree on non-code pages
* When asking for token, show more detailed message and not fly out automatically
* Extend pjax timeout to work better with big files
* Sanitize file and folder names before displaying
* Fix error when a branch name contains slashes
* Gulp script to build for Chrome, Firefox and Safari
* And some other minor changes


## Donating
Support this project and others via [Gittip](https://www.gittip.com/buunguyen/).

[![Support via Gittip](https://rawgithub.com/twolfson/gittip-badge/0.2.0/dist/gittip.png)


## Credit
* Many thanks to all contributors who submit pull requests, report bugs and suggest ideas
* [Extension icon](https://github.com/pstadler/octofolders) by [pstadler](https://github.com/pstadler)
Initial commit 2014-05-10 08:06:38 +08:00			`## Octotree`
Add binary dist for Firefox, Safari and Opera 2014-05-26 00:49:00 +08:00			`Browser extensions (Chrome, Firefox, Safari and Opera) 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:`
Support Pjax 2014-05-12 01:14:25 +08:00
Updated read me 2014-05-12 01:24:39 +08:00			`* Easy-to-navigate code tree like IDEs`
Update readme 2014-05-13 13:47:49 +08:00			`* Fast browsing with pjax`
Refactor margin moving code 2014-06-09 03:29:43 +08:00			`* Customizable hotkey`
Update read me and bump version 2014-07-26 07:56:41 +08:00			`* Support private repositories (see [instructions](#github-access-token))`
			`* Support GitHub Enterprise (Chrome and Opera only, see [instructions](#github-enterprise))`
Initial commit 2014-05-10 08:06:38 +08:00
Modify README to point to Mozilla store 2014-07-15 01:39:51 +08:00			`## Install on Chrome and Firefox`
			`* Download and install Octotree from [Chrome Web Store](https://chrome.google.com/webstore/detail/octotree/bkhaagjahfmjljalopjnoealnfndnagc) or [Mozilla Add-ons Store](https://addons.mozilla.org/en-US/firefox/addon/octotree/)`
Update read me and bump version 2014-07-26 07:56:41 +08:00			`* Navigate to any GitHub repository (or just refresh this page as an example)`
Refactor margin moving code 2014-06-09 03:29:43 +08:00			`* The code tree should show on the left-hand side of the screen`
Initial commit 2014-05-10 08:06:38 +08:00
Update read me 2014-07-27 00:43:14 +08:00			`## Install on Safari and Opera`
Modify README to point to Mozilla store 2014-07-15 01:39:51 +08:00			`You can install the prebuilt extensions located in the [dist](https://github.com/buunguyen/octotree/tree/master/dist) folder. For security reason, only download Octotree from this location.`
Update read me 2014-05-14 14:35:58 +08:00
Update read me 2014-07-27 00:43:14 +08:00			* Safari: drag `safari.safariextz` to the browser and follow the instructions
			* Opera: drag `opera.nex` to the browser and follow the instructions
Update read me 2014-05-14 14:35:58 +08:00
Update read me and bump version 2014-07-26 07:56:41 +08:00			`## GitHub access token`
Initial commit 2014-05-10 08:06:38 +08:00			`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:`

Add prebuilt Firefox & Safari extensions 2014-05-14 14:27:02 +08:00			`* You access a private repository`
Initial commit 2014-05-10 08:06:38 +08:00			`* You exceed the [rate limit of unauthenticated requests](https://developer.github.com/v3/#rate-limiting)`

Update read me and bump version 2014-07-26 07:56:41 +08:00			When that happens, Octotree will ask for your [GitHub personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use). If you don't already have one, [create one](https://github.com/settings/tokens/new), then copy and paste it into the textbox. Note that the minimal scopes that should be granted are `public_repo` and `repo` (if you need access to private repositories).
Initial commit 2014-05-10 08:06:38 +08:00
Updated readme 2014-05-14 14:39:25 +08:00			`Alternatively, you can manually enter or update the token by following these steps:`
Initial commit 2014-05-10 08:06:38 +08:00
Update read me and bump version 2014-07-26 07:56:41 +08:00			`* Navigate to any GitHub repository`
Update read me 2014-05-14 14:35:58 +08:00			`* Open the Chrome (or Safari, Firefox) developer console`
Initial commit 2014-05-10 08:06:38 +08:00			`* Execute the following line:`
			```javascript
Update read me to add changelog 2014-05-16 02:19:57 +08:00			`localStorage.setItem('octotree.github_access_token', 'REPLACE WITH TOKEN')`
Initial commit 2014-05-10 08:06:38 +08:00			```

Update read me 2014-07-27 00:43:14 +08:00			`Note: if you use GitHub Enterprise, each site will need its own access token. Therefore, Octotree stores access token on a per-site basis.`
Update read me and bump version 2014-07-26 07:56:41 +08:00

			`## GitHub Enterprise`
Update read me 2014-07-27 00:43:14 +08:00			By default, Octotree only works on `github.com`. To support GitHub Enterprise on Chrome or Opera, you must grant Octotoree sufficient permissions. Follow these steps to do so:
Update read me and bump version 2014-07-26 07:56:41 +08:00
Update read me 2014-07-27 00:43:14 +08:00			* Navigate to any GitHub repository on `github.com`
Update read me and bump version 2014-07-26 07:56:41 +08:00			`* Open Octotree's setting panel`
Update read me 2014-07-27 00:43:14 +08:00			`* Fill in the GitHub Enterprise URLs textbox, one site URL per line`
Update read me and bump version 2014-07-26 07:56:41 +08:00			`* Click Save and accept any permission prompt`
			`* Navigate to your GitHub Enterprise site (or refresh if you're already in one)`
			`* You might be asked to create an [access token](#github-access-token)`


Update read me to add changelog 2014-05-16 02:19:57 +08:00			`## Changelog`
Release 1.4.1 2014-08-21 03:49:37 +08:00
			`### [v1.4.1](https://github.com/buunguyen/octotree/issues?q=milestone%3A1.4.1+is%3Aclosed)`
			`* New header to match new GitHub design`
			`* Bug fixes`

Update read me and bump version 2014-07-26 07:56:41 +08:00			`### [v1.4](https://github.com/buunguyen/octotree/issues?labels=&milestone=4&page=1&state=closed)`
			`* Support GitHub enterprise`
			* Change default hotkey (`cmd+b` for Safari and `cmd+shift+s` for all other browsers)
			`* Some other minor changes`

Version 1.3 2014-06-11 03:01:13 +08:00			`### [v1.3](https://github.com/buunguyen/octotree/issues?labels=&milestone=3&page=1&state=closed)`
			`* Setting panel allowing:`
			`* Changing access token`
			`* Changing hotkeys`
Fix typo 2014-06-11 03:05:39 +08:00			`* Changing sidebar default visibility`
Version 1.3 2014-06-11 03:01:13 +08:00			`* Changing folder collapsing option`
			`* Sidebar appears better in large monitors`
			`* More responsive in big repositories`
			`* And bug fixes`

Version 1.2 2014-05-26 00:41:24 +08:00			`### [v1.2](https://github.com/buunguyen/octotree/issues?labels=&milestone=1&page=1&state=closed)`
			`* Hide sidebar by default (upon many user requests)`
			* Hotkey (`cmd+b`, `ctrl+b`) to toggle sidebar
			`* Sidebar is now resizable`
			`* Support rendering submodules`
			`* Reflect GitHub selection to Octotree`
			`* New sidebar header and progress indicator`
			`* And bug fixes`

			`### [v1.1](https://github.com/buunguyen/octotree/issues?labels=&milestone=2&page=1&state=closed)`
			`* New UI that blends better with GitHub!`
			`* Hide Octotree on non-code pages`
			`* When asking for token, show more detailed message and not fly out automatically`
			`* Extend pjax timeout to work better with big files`
			`* Sanitize file and folder names before displaying`
			`* Fix error when a branch name contains slashes`
			`* Gulp script to build for Chrome, Firefox and Safari`
Update read me to add changelog 2014-05-16 02:19:57 +08:00			`* And some other minor changes`
Initial commit 2014-05-10 08:06:38 +08:00
Release 1.4.1 2014-08-21 03:49:37 +08:00
			`## Donating`
			`Support this project and others via [Gittip](https://www.gittip.com/buunguyen/).`

			`[![Support via Gittip](https://rawgithub.com/twolfson/gittip-badge/0.2.0/dist/gittip.png)`

Initial commit 2014-05-10 08:06:38 +08:00
			`## Credit`
Update read me and bump version 2014-07-26 07:56:41 +08:00			`* Many thanks to all contributors who submit pull requests, report bugs and suggest ideas`
Version 1.2 2014-05-26 00:41:24 +08:00			`* [Extension icon](https://github.com/pstadler/octofolders) by [pstadler](https://github.com/pstadler)`