branch: externals/topspace commit 09d47d32b84b1c214e2972eb06523252b4093930 Author: Trevor Pogue <trevorpo...@gmail.com> Commit: GitHub <nore...@github.com>
Add MELPA badge and installation instructions --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1a59397b93..c556e1f0aa 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ # TopSpace + +[](http://melpa.org/#/topspace) +[](https://www.gnu.org/licenses/gpl-3.0) + **Scroll above the top line**  - TopSpace is an Emacs minor mode that lets you scroll above the top line to vertically center top text. No new keybindings are required as `topspace` automatically works for any @@ -13,6 +16,16 @@ scrolling commands/functions available in Emacs as far as the author is aware. Bonus: If you use [`centered-cursor-mode`][1], this means that `topspace` will automatically let you center the cursor all the way to the top line! +### Installation + +TopSpace is available on [MELPA](http://melpa.org). +After [installing MELPA](https://melpa.org/#/getting-started) you can install TopSpace with the following command: + +<kbd>M-x</kbd> `package-install` <kbd>[RET]</kbd> `topspace` <kbd>[RET]</kbd> + +Then enable TopSpace locally with <kbd>M-x</kbd> `topspace-mode`, or globally with <kbd>M-x</kbd> `global-topspace-mode`. +Alternatively, add `(global-topspace-mode 1)` to your Emacs config to enable `topspace-mode` globally on startup. + # Customization ```