properly added shell completions

[charsel.git] / README.md

diff --git a/README.md b/README.md
index c4bd7c3842b81d8c4c95e4a5eab84b1e74be848a..a3705005485140acc0c9c531e46c9d1789e65a22 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,35 @@
-# charsel
-A very simple comand line tool to make a shortcut to a special characther. 
-It takes the input of a .char file, 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 .char file is just two columns with the shortcut on the left, then a separator, then the special charachter to be copied.
-
-## DEPENDENCIES
-posix shell
-util-linux
-xclip
-
-## USAGE
-charselect.sh $charfile
+# CHARSEL
+A simple bash script to make copying frequently used special characters to your clipboard easy.
+
+It uses a plain-text file known as a "charfile" to define easy to reach shortcuts to special characters
+
+## Installation
+- Run `make install` as root to install
+- Run `make uninstall` as root to remove. Will not delete your personal charfiles
+- Run `make purge` as a normal user to remove charsel files from your home directory
+
+## Dependencies
+  * Bash
+  * Linux
+  * Xclip
+  * A terminal with UTF-8 encoding enabled
+
+## Usage
+For argument usage, use `charsel -h`
+
+Once you [have](have) started the program, simply type the shortcut listed on the left side of the table to copy the character on the right side of the table to your clipboard. Shortcodes the same length as the longest one will automatically be entered. To quit, type ';' as a shortcode
+
+Some of the default charfiles have hidden shortcuts for capital letters that are not shown on the table. Simply type a capital version of the shortcut key to access the capital version of the special character.
+
+## Creating a charfile
+Make a new file in the `~/.local/share/charsel/charfiles/` or `/usr/share/charsel/charfiles/` directories with the name that you would like to use to call the charfile in the command.
+
+Fill it in, using the provided examples as a template. Hidden shortcuts go above the '-', lines can be commented out using a '#' at the start of the line. ';' cannot be used as a shortcode, as that is used to quit the program
+
+## Shell completions
+There is a shell completion script provided. To install it, use `make install-completions`
+
+## License
+Charfile is GNU GPLv3 licensed, see COPYING for more information
+
+Charfile is written by [Armaan Bhojwani](https://armaan.bhojwani.org), [Email](mailto:3fb650a9-b47e-4604-a282-1dd91953b2ee@anonaddy.me)