update formatting, refactor

[charsel.git] / README.md

diff --git a/README.md b/README.md
index b0f81dc084a4906e3fd7938da9b8bf8e31001f15..f0a7f3fe5b5dfad157b2588f97447d631cbaf155 100644 (file)
--- a/README.md
+++ b/README.md
@@ -27,11 +27,10 @@ Make a new file in `~/.local/share/charsel/charfiles/` or `/usr/share/charsel/ch
 
 Fill in your shortcodes, using the provided examples in `/usr/share/charsel/charfiles` as a template. There are just 4 rules to follow.
   1. The pattern is "shortcode,output"
-  2. Hidden shortcuts go above the line with '---'
-  3. Lines can be commented out using a '#' at the start
-  4. ";" cannot be used as a shortcode, as that is used to quit the program
+  2. Hidden shortcuts go above the line with "---"
+  3. Lines can be commented out using a "#" at the start
+  4. Shortcodes may not contain ";" (semicolon) as that is used to quit the program
+  5. Shortcodes cannot start with - as that confuses grep
 
 ## 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)
+Copyright Armaan Bhojwani 2020, MIT License, see the LICENSE file for more information