branch: externals/topspace
commit 50aae1cbdde72409e166fada69ba43d7d15aae40
Author: Trevor Pogue <pogu...@mcmaster.ca>
Commit: GitHub <nore...@github.com>
Update README.md
---
README.md | 34 +++++++++++++++++++++++++++++++++-
1 file changed, 33 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index be50e0337e..372dfc0848 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
-`topspace` is an emacs minor mode that lets you scroll above the top line to
vertically center top text.
+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
commands or subsequent function calls which use `scroll-up`, `scroll-down`,
@@ -13,6 +13,38 @@ scrolling commands/functions available in Emacs that the
author is aware of.
Bonus: If you use [`centered-cursor-mode`][3], this means that `topspace` will
automatically let you center the cursor all the way to the top line!
+# Customization
+
+```
+(defcustom topspace-autocenter-buffers
+ t
+ "Vertically center small buffers when first opened or window sizes change."
+ :group 'topspace
+ :type 'boolean)
+
+(defcustom topspace-center-position
+ 0.5
+ "Suggested position when centering buffers as a ratio of frame height.
+A value from 0 to 1 where lower values center buffers higher up in the screen.
+
+Used in `topspace-recenter-buffer' when called or when opening/resizing buffers
+if `topspace-autocenter-buffers' is non-nil."
+ :group 'topspace
+ :type 'float)
+```
+
+# Extra commands
+
+### `topspace-recenter-buffer`:
+
+Add enough top space in the selected window to center small buffers.
+
+Top space will not be added if the number of text lines in the buffer is larger
+than or close to the selected window's height.
+
+Customize `topspace-center-position` to adjust the centering position.
+Customize `topspace-autocenter-buffers` to run this command automatically
+after first opening buffers and after window sizes change.
<!-- # Installation -->
<!-- Save the file from this repository named `"topspace.el"` into a directory
of your choice, then install it using [`use-package`][2] by adding the
following lines to your [`init file`][1]: -->
