aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..344b4e0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# Lazy Numbers
+
+<div style="text-align=center">
+<img src="./screenshot/opinion.png">
+</div>
+
+Enter Numbers without moving your hands off the home row!!!
+
+![](./screenshot/example.gif)
+
+## Install
+
+### MELPA:
+
+```
+M-x package-install lazy-numbers
+```
+
+## use-package
+
+```elisp
+(use-package lazy-numebrs
+ :ensure t)
+```
+
+### Manual installation
+
+```elisp
+(add-to-list 'load-path "/path/to/lazy-numbers/")
+(require 'lazy-numbers)
+
+(global-set-key (kbd "C-'") #'lazy-number-enter)
+```
+
+### Usage
+
+Press `C-'` to enter **home-row number input mode**, then use
+
+```
+a s d f g h j k l ;
+1 2 3 4 5 6 7 8 9 0
+```
+
+Press `ESC` to exit.
+
+
+## About
+