Merge pull request #32 from EnixCoda/update-readme

Update readme
This commit is contained in:
Enix 2019-08-24 15:31:07 +08:00 committed by GitHub
commit 87f141d12e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 369 additions and 18 deletions

349
ChromeWebStoreBadge.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 37 KiB

View file

@ -1,31 +1,32 @@
# Gitako
Yet another Chrome extension for GitHub. Inspired by [Octotree](https://github.com/buunguyen/octotree) & [GayHub](https://github.com/jawil/GayHub), thanks to them! Gitako is aimed at providing better UX, consistent UI regards to GitHub and more essential features.
Yet another Chrome extension for GitHub. Inspired by [Octotree](https://github.com/buunguyen/octotree) & [GayHub](https://github.com/jawil/GayHub), thanks to them! Gitako is aimed at providing the best performance, better UX, more consistent UI and more essential features.
### Features
- [x] neat file tree
- [x] instant file search
- [x] fast even in gigantic projects
- [x] intuitive keyboard accessibility
- file navigation using arrow keys
- set shortcut to toggle sidebar
- [x] redirect smoothly with pjax
- [x] resize-able when window is wide enough
- [x] copy snippets with single click
- 📂 neat file tree
- 🔎 instant file search
- 🏎 super fast even in gigantic projects
- ⌨️ intuitive keyboard accessibility
- navigate file using arrow keys
- shortcut for toggling sidebar
- 🚀 boosts loading speed
- ↔️ customizable size
- 📋 copy with single click
- copy code snippets from markdown preview
- copy whole content of a file
- [x] support private repo and frequent usages
- [x] support git submodule
- [x] UI consistent to GitHub's
- [x] light size (~60kb) & low memory usage
- [more WIP](https://github.com/EnixCoda/Gitako/projects/1)
[Change Log](https://github.com/EnixCoda/Gitako/wiki/ChangeLog)
- 🤖 support private repo and frequent usages
- 🎨 UI consistent to GitHub's
- 🎈 light size (~60kb) & low memory usage
- 🗂 support git submodule
### Install
[Please install from Chrome Web Store](https://chrome.google.com/webstore/detail/gitako/giljefjcheohhamkjphiebfjnlphnokk)
<div style="max-width: 300px">
[![Please install from Chrome Web Store](./ChromeWebStoreBadge.svg)](https://chrome.google.com/webstore/detail/gitako-github-file-tree/giljefjcheohhamkjphiebfjnlphnokk)
</div>
### Issues
@ -34,6 +35,7 @@ Any bug report or feature request discussions are welcomed, feel free to draft a
### About
#### Why named 'Gitako'?
GitHub's totem is a cute octopus. And octopus in Japanese is `たこ`(tako).
Then link them together: