From 91ad9892e694717eb62c6c001888d8d5130cf607 Mon Sep 17 00:00:00 2001 From: EnixCoda Date: Sun, 28 Oct 2018 17:59:51 +0800 Subject: [PATCH] docs: update readme --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d8a5d44..722a26d 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,35 @@ # Gitako -Yet another Chrome extension for GitHub. Inspired by [Octotree](https://github.com/buunguyen/octotree) & [GayHub](https://github.com/jawil/GayHub). 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 better UX, consistent UI regards to GitHub and more essential features. ### Features - [x] neat file tree - [x] instant file search -- [x] keyboard accessibility - - press 'up' and 'down' to nav between search input and files in the list - - press 'enter' or 'right' to redirect to file or expand folder - - press 'left' to jump to parent folder or collapse current folder +- [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] enlargeable when window is wide enough -- [x] copy snippets with one click - - copy code snippets inside markdown preview - - copy all contents of a file -- [x] support access token (for private repo and frequent usage) -- [x] consistent UI with GitHub - - [x] use [octicons](https://octicons.github.com) +- [x] resize-able when window is wide enough +- [x] copy snippets 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) -### Download +### Install -[install from Chrome web store](https://chrome.google.com/webstore/detail/gitako/giljefjcheohhamkjphiebfjnlphnokk) +[Please install from Chrome Web Store](https://chrome.google.com/webstore/detail/gitako/giljefjcheohhamkjphiebfjnlphnokk) ### Issues -Any bug report or feature requests are welcomed, feel free to draft a [issue](https://github.com/EnixCoda/Gitako/issues/)! +Any bug report or feature request discussions are welcomed, feel free to draft a [issue](https://github.com/EnixCoda/Gitako/issues/)! ### About