# What is OctoLinker? [](https://travis-ci.org/OctoLinker/browser-extension) [](https://ci.appveyor.com/project/stefanbuck/browser-extension)
First of all, it's a browser extension. Once installed, it allows you to navigate through projects on GitHub.com efficiently.
Most projects consist of many files and third party dependencies. Files are referencing other files and / or dependencies by language specific statements like `include` or `require`. Dependencies are most likely declared in a file called manifest e.g. `package.json` or `Gemfile`. The OctoLinker browser extensions makes these references clickable. No more copy and search.
# Install
Install OctoLinker from [Chrome Web Store](https://chrome.google.com/webstore/detail/octo-linker/jlmafbaeoofdegohdhinkhilhclaklkp), [Mozilla Add-ons Store](https://addons.mozilla.org/en-US/firefox/addon/octolinker/) or [Opera Add-ons Store](https://addons.opera.com/en/extensions/details/octolinker/).
# Features
OctoLinker is the easiest and best way to navigate between files and projects on GitHub.com. Files containing the following keywords will now have links that redirect you either to the relative file or to the projects GitHub page. Depending on the value, it may redirect you to an external website like a manual page or another service.
### bower.json (Bower)
- `main`
- `dependencies`
- `devDependencies`
- `resolutions`
### composer.json (Composer)
- `require `
- `require-dev`
- `conflict`
- `replace`
- `provide`
- `suggest`
### Dockerfile (Docker)
- `FROM`
### Homebrew
- `depends_on`
- `conflicts_with`
- `depends_on cask`
- `depends_on formula`
### JavaScript / NodeJS
- `require`
- `import`
- `export`
### package.json (npm)
- `main`
- `bin`
- `browser`
- `dependencies`
- `devDependencies`
- `resolutions`
- `peerDependencies`
- `optionalDependencies`
- `types` and `typings`
### Python
- `import`
- `from`
### Ruby
- `require`
### Rubygems
- `gem`
### Rust
- `extern crate`
- `use`
### TypeScript
- `import`
- ``
### Vim
- `Bundle`
- `NeoBundle`
- `NeoBundleFetch`
- `NeoBundleLazy`
### project.json (.NET Core)
- `dependencies`
- `tools`
### Go
- `import`
# Want to contribute?
Anyone can help make this project better - check out the [Contributing](/CONTRIBUTING.md) guide!
# Feedback please
If you encounter a problem using OctoLinker, or would like to request an enhancement, feel free to create an [issue](https://github.com/OctoLinker/browser-extension/issues) or say hello [@OctoLinker](https://twitter.com/OctoLinker) on twitter.
# Thanks
- My girlfriend for being so patient with me!
- [@josephfrazier_](https://twitter.com/josephfrazier_) for his awesome contributions to this project!
- [art-noir.net](http://art-noir.net) for the awesome mascot and website!
- [@kkamilio](https://twitter.com/kkamilio) and [@WolnyAdrian](https://twitter.com/WolnyAdrian) for teaching me how Ruby works!
- [@TheeApeman](https://twitter.com/TheeApeman) for code review!
- Every early OctoLinker user, which contributed to OctoLinker by writing issues or PRs!
- Everyone I forgot to mention here, but also influenced OctoLinker!
##Support
Show your support to our open source project. Your donation will help us to cover project expenses and allow the maintainers to dedicate more time for maintenance and new features for everyone.
- [Buy OctoLinker stickers](https://www.stickermule.com/marketplace/16611-the-official-logo)
- [Donate with PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=WSXA9GCDRMX7W)
- [Become a backer or sponsor](https://opencollective.com/octolinker)
# Legal and License
The OctoLinker project is not affiliated with, sponsored by, or endorsed by github, inc.
Copyright (c) 2014–present [Stefan Buck](https://github.com/stefanbuck) Licensed under the MIT license.