Update README
This commit is contained in:
parent
26da61ebb9
commit
807ad71916
14
README.md
14
README.md
|
@ -2,11 +2,13 @@
|
|||
Browser extensions (Chrome, Firefox, Opera and Safari) to display GitHub and GitLab code in tree format. Useful for developers who frequently read source and do not want to download or checkout too many repositories. Features:
|
||||
|
||||
* Easy-to-navigate code tree like IDEs
|
||||
* Fast browsing with pjax
|
||||
* Fast browsing with pjax (currently, only GitHub)
|
||||
* Customizable hotkey
|
||||
* Support private repositories (see [instructions](#access-token))
|
||||
* Support GitHub and GitLab Enterprise (Chrome and Opera only, see [instructions](#enterprise-deployment))
|
||||
* Support GitHub and GitLab Enterprise (Chrome and Opera only, see [instructions](#enterprise-urls))
|
||||
|
||||

|
||||

|
||||
|
||||
## Install on Chrome, Firefox and Opera
|
||||
* Install Octotree from [Chrome Web Store](https://chrome.google.com/webstore/detail/octotree/bkhaagjahfmjljalopjnoealnfndnagc), [Mozilla Add-ons Store](https://addons.mozilla.org/en-US/firefox/addon/octotree/) or [Opera Add-ons Store](https://addons.opera.com/en/extensions/details/octotree/)
|
||||
|
@ -44,11 +46,11 @@ By default, Octotree only works on `github.com` and `gitlab.com`. To support ent
|
|||
* Navigate to your GitHub or GitLab Enterprise site
|
||||
* You might be asked to create an [access token](#access-token)
|
||||
|
||||
### Other Settings
|
||||
### Settings
|
||||
* __Hotkeys__: Octotree uses [keymaster](https://github.com/madrobby/keymaster) to register hotkeys. Checkout the [supported keys](https://github.com/madrobby/keymaster#supported-keys).
|
||||
* __Remember sidebar visibility__: if checked, will show or hide Octotree based on its previous visibility.
|
||||
* __Show in non-code pages__: if checked, allow Octotree to show in non-code pages such as Issues and Pull Requests.
|
||||
* __Load entire tree at once__: if checked, will issue a single API request to load the entire code tree. Could be slow in very large repos, in which case this option should be unchecked.
|
||||
* __Remember sidebar visibility__: if checked, show Octotree based on its previous visibility.
|
||||
* __Show in non-code pages__: if checked, allow Octotree to show in non-code pages such as Issues, Pull Requests and Wiki etc.
|
||||
* __Load entire tree at once__: if checked, issue a single API request to load the entire code tree. Could be slow in very large repos, in which case this option should be unchecked.
|
||||
|
||||
|
||||
## Changelog
|
||||
|
|
BIN
docs/chrome.png
BIN
docs/chrome.png
Binary file not shown.
Before Width: | Height: | Size: 378 KiB |
BIN
docs/firefox.png
BIN
docs/firefox.png
Binary file not shown.
Before Width: | Height: | Size: 416 KiB |
Binary file not shown.
After Width: | Height: | Size: 714 KiB |
Binary file not shown.
After Width: | Height: | Size: 788 KiB |
BIN
docs/opera.png
BIN
docs/opera.png
Binary file not shown.
Before Width: | Height: | Size: 315 KiB |
BIN
docs/safari.png
BIN
docs/safari.png
Binary file not shown.
Before Width: | Height: | Size: 372 KiB |
|
@ -28,7 +28,7 @@
|
|||
<form class="octotree_view_body">
|
||||
<div>
|
||||
<label>Site access token</label>
|
||||
<a class="octotree_help" href="https://github.com/buunguyen/octotree#octotree-settings" target="_blank" tabIndex="-1">
|
||||
<a class="octotree_help" href="https://github.com/buunguyen/octotree#settings" target="_blank" tabIndex="-1">
|
||||
<span></span>
|
||||
</a>
|
||||
<input type="text" data-store="TOKEN" data-perhost="true">
|
||||
|
|
Loading…
Reference in New Issue