emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/topspace 09d47d32b8 023/181: Add MELPA badge and instal


From: ELPA Syncer
Subject: [elpa] externals/topspace 09d47d32b8 023/181: Add MELPA badge and installation instructions
Date: Tue, 23 Aug 2022 12:58:30 -0400 (EDT)

branch: externals/topspace
commit 09d47d32b84b1c214e2972eb06523252b4093930
Author: Trevor Pogue <trevorpogue@gmail.com>
Commit: GitHub <noreply@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
+
+[![MELPA](http://melpa.org/packages/topspace-badge.svg)](http://melpa.org/#/topspace)
+[![License: GPL 
v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
 **Scroll above the top line**
 
 
![topspace](https://user-images.githubusercontent.com/12535207/154770200-0b3edcd8-8036-40c7-910f-d5b3a1c3b4df.gif)
 
-
 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
 
 ```



reply via email to

[Prev in Thread] Current Thread [Next in Thread]