[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
```
- [elpa] externals/topspace 79aa4e78d3 001/181: Initial commit, (continued)
- [elpa] externals/topspace 79aa4e78d3 001/181: Initial commit, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace ca7a6ba61a 004/181: fixed typo in README instruction, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace a4e61e164a 008/181: Update README.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 42353585e0 005/181: Minor code improvements from the "low hanging fruit" in initial commit:, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 40cf3cfe5f 007/181: Update README.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 8ce487bd3d 014/181: Merge pull request #1 from trevorpogue/dev, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace f15aea8579 016/181: Remove unused private variables and add .dir-locals.el, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 50aae1cbdd 011/181: Update README.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace d8ba41b20e 020/181: Make topspace-enable and topspace-disable private functions, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 694c10574c 012/181: Update topspace.el, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 09d47d32b8 023/181: Add MELPA badge and installation instructions,
ELPA Syncer <=
- [elpa] externals/topspace 512893f002 021/181: Provide documentation strings for private variables, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 976971f4a9 024/181: Add clarification to Installation steps, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace f36c0e28af 025/181: Add MELPA Stable badge, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 73cb30dc10 028/181: Add more info on how it works to README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 8591032298 029/181: Add to package motivation in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace a76d4f3612 031/181: Update to more clear GIF in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 4eb27abaa1 034/181: Prevent top space from all suddenly disappearing when visual-line-mode is enabled and cursor scrolls bellow screen with top space present, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 7a3c9703a5 041/181: Fix links in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace c6bc481049 042/181: Fix links in README, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 7303661244 043/181: Update headers in README, ELPA Syncer, 2022/08/23