ff53e8636f | ||
---|---|---|
icons | ||
lib | ||
.gitignore | ||
LICENSE | ||
README.md | ||
inject.css | ||
inject.js | ||
manifest.json | ||
screen_ext.png | ||
screen_store.png | ||
screen_token.png |
README.md
Octotree
Chrome extension to display GitHub code in tree format. Useful for code junkies like me who frequently read source in GitHub and do not want download or checkout every single repository.
Install
- Download and install Octotree from the Chrome store
- Navigate to any GitHub project (or just refresh this page as an example)
- The code tree should show as follows:
GitHub API Rate Limit
Octotree uses GitHub API 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 are accessing a private repository
- You exceed the rate limit of unauthenticated requests
When that happens, Octotree will show use the following screen to ask for your GitHub personal access token.
If you don't already have one, create one at this page. Then enter the generated token into the textbox and save.
Alternatively, you can always manually enter or update the token by following these steps:
- Navigate to any GitHub page
- Open the Chrome developer console
- Execute the following line:
localStorage.setItem('octotree.github_access_token', 'REPLACE WITH TOKEN')
Contribution
There are several improvements that can be made to Octotree. Contribution is very welcome.
- Make the width of the tree panel resizable
- Allow users to enter access token any time (i.e. a new button?)
- Synchronize selection if users click on GitHub links directly (instead of via Octotree)
- Show progress indicator while a repository is being loaded