diff --git a/README.md b/README.md index c1fd5f8920..a49970f787 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,73 @@ -# GitHub Package +# Atom GitHub Package [![Build Status](https://travis-ci.com/atom/github.svg?token=RwrCnzpsZN5oEq5S5p7V&branch=master)](https://travis-ci.com/atom/github) +The Atom GitHub package provides Git and GitHub integration for Atom. + ## Installation -In the Atom settings view, click the "Install" tab, paste the URL to this repository in the box, and press Enter. Note that you may need to use the SSH URL to the repo if Git doesn't have your HTTPS credentials cached. +You may install the GitHub package via the Atom GUI or via the command line. + +**Settings View** + +In settings view, click "Install," enter `atom/github` in the search field, and press enter. In the installation card that appears, click "Install." + +![Installation via settings view](./docs/install-settings-view.png) + + +**Command Line** + +Run `apm install atom/github`. + +## Keyboard Shortcuts + +The default keyboard shortcuts are: + +* `ctrl-9` :point_right: Show/hide the Git panel +* `ctrl-shift-9` :point_right: Toggle Git panel focus + +From within the Git panel: + +* `enter` :point_right: Stage/unstage the currently selected file +* `cmd/ctrl-enter` :point_right: Commit (or move to the commit box) +* `tab` :point_right: Focus the next list/commit box +* `shift-tab` :point_right: Focus the previous list + +From within a diff view: + +* `/` :point_right: Toggle between selection of hunks and lines +* `tab` :point_right: Move to the next hunk +* `shift-tab` :point_right: Move to the previous hunk +* `enter` :point_right: Stage/unstage the currently selected hunk or line + +## Feedback + +Please feel free to post your comments, feedback, and issues [in the GitHub repository](https://github.com/atom/github/issues). ## Current Status -This package is currently :construction: under heavy development. :construction: While its existence isn't a secret, we've chosen not to share that we're working on it with the public quite yet to avoid the too-many-cooks-in-the-kitchen problem. Please constrain conversation about this package to the #atom-maintainers room and other private GitHub channels. +This package is currently :construction: under heavy development. :construction: The following checked features are done, while others are in the works or are planned for the future: + +**Git** + +- [x] Stage files/hunks/lines +- [x] Unstage files/hunks/lines +- [ ] Discard changed files/hunks/lines +- [x] Create commits +- [x] Amend last commit +- [ ] Sign commits ([#396](https://github.com/atom/github/pull/396)) +- [x] Change branches +- [x] Create new branches +- [x] Push/pull/fetch +- [x] Abort merges +- [ ] Resolve merge conflicts via special UI ([#385](https://github.com/atom/github/pull/385)) + +**GitHub** + +- [ ] Show current PR details +- [ ] Open a new PR +- [ ] Show PR comments inline in the editor +- [ ] Edit PRs +- [ ] Create/edit PR comments +- [ ] Perform GitHub.com code reviews from within Atom +- [ ] Merge/close PRs diff --git a/docs/install-settings-view.png b/docs/install-settings-view.png new file mode 100644 index 0000000000..61a9ea8c34 Binary files /dev/null and b/docs/install-settings-view.png differ