diff --git a/README.md b/README.md index 399e8c5..382a590 100644 --- a/README.md +++ b/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)) +![Octotree on GitHub](docs/github.png) +![Octotree on GitLab](docs/gitlab.png) ## 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 diff --git a/docs/chrome.png b/docs/chrome.png deleted file mode 100644 index bd6dc26..0000000 Binary files a/docs/chrome.png and /dev/null differ diff --git a/docs/firefox.png b/docs/firefox.png deleted file mode 100644 index d0c9fa4..0000000 Binary files a/docs/firefox.png and /dev/null differ diff --git a/docs/github.png b/docs/github.png new file mode 100644 index 0000000..8b072d6 Binary files /dev/null and b/docs/github.png differ diff --git a/docs/gitlab.png b/docs/gitlab.png new file mode 100644 index 0000000..b62cf9b Binary files /dev/null and b/docs/gitlab.png differ diff --git a/docs/opera.png b/docs/opera.png deleted file mode 100644 index 48b8dd1..0000000 Binary files a/docs/opera.png and /dev/null differ diff --git a/docs/safari.png b/docs/safari.png deleted file mode 100644 index dd7d643..0000000 Binary files a/docs/safari.png and /dev/null differ diff --git a/src/template.html b/src/template.html index bc46462..5ec00e7 100644 --- a/src/template.html +++ b/src/template.html @@ -28,7 +28,7 @@
- +