commit 1a0272e3bf5a2e978f24843c84d87f1d3cf9c94b Author: EnixCoda Date: Sun Jan 7 12:45:04 2018 +0800 initialize README and License diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9336a94 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2017 EnixCoda + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..1e406c8 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# 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. + +### Features + +- [x] neat file tree +- [x] instant search for files +- [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] redirect with pjax +- [x] copy snippets with one click +- [x] support access token (for private repo and frequent usage) +- [x] fancy loading animation ;) +- [x] use [octicons](https://octicons.github.com) +- [x] light size (40kb) & low memory usage +- [more WIP](https://github.com/EnixCoda/Gitako/projects/1) + +### Download + +[install from Chrome web store](https://chrome.google.com/webstore/detail/gitako/giljefjcheohhamkjphiebfjnlphnokk) + +### Issues + +Any bug report or suggestions are welcomed, feel free to draft a [issue](https://github.com/EnixCoda/Gitako/issues/)!