1.0 release!

[charsel.git] / README.md

diff --git a/README.md b/README.md
index 9606ad8b630cb981e0aaee9aef9ea27466679f76..e6849412424d7692a8cdcbe5ff257c6f1087a8b5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,14 +4,15 @@ A very simple shell script to make copying frequently used special characters to
 It uses a plain-text file known as a "charfile" to define shortcuts to special characters that are easy to access on the keyboard.
 
 ## Installation
-Running the INSTALL.sh script should work fine for most people
+Running the INSTALL.sh script should work fine for most people.
+
 If it is run as root or with sudo, the program and charfiles will be installed for all users. If it is run without elevated privileges, it will just be installed for the local user.
 
 ## Dependencies
-Posix shell
-util-linux
-xclip
-A terminal with UTF-8 encoding enabled
+  * Posix shell  
+  * util-linux  
+  * xclip  
+  * A terminal with UTF-8 encoding enabled  
 
 ## USAGE
 To start the program, run `charsel <charfile>`
@@ -25,3 +26,11 @@ The default charfiles all have hidden shortcuts for capital letters that are not
 Make a new file in `~/.local/share/charsel/` or `/usr/share/charsel` 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 '---'
+
+## 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)
+
+## BRANCHES
+Development happens on the "development" branch, which then gets merged into the "master" branch once its ready for a stable release