Small changes to improve usability

[charsel.git] / README.md

diff --git a/README.md b/README.md
index d46893a61760fa48c9360d2e4e71582d8ffee944..6ce415bf63f59fe0629b3a6bc02ff2a4f07f753b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
-A command line tool using xclip to copy special charachters. UTF-8 encoding required
+# charsel
+A very simple comand line tool to make a shortcut to a special characther. 
+
+It takes the input of a charfile, then puts it into a table and waits for your input. Once you put in your shortcut key, it prints the special character then copies it to the clipboard.
+
+A charfile is just two columns with the shortcut on the left, then a separator, then the special charachter to be copied.
+
+## INSTALLATION
+Run the INSTALL.sh script
+If run as root, it will be installed globally, if run without root, it will be just instaled for the local user
+
+## DEPENDENCIES
+posix shell
+util-linux
+xclip
+
+## USAGE
+charsel <charfile>
+
+## CREATING A CHARFILE
+Make a new file in ~/.local/share/charsel/ with the name that you want to use to call the file in the command
+Fill it in, using the provided example as a template.