updated readme

[charsel.git] / README.md

diff --git a/README.md b/README.md
index e6849412424d7692a8cdcbe5ff257c6f1087a8b5..0d3f76545953488b512b9919af2cc82128893fe3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,15 +1,14 @@
 # CHARSEL
-A very simple shell script to make copying frequently used special characters to your clipboard easy.
+A very 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 shortcuts to special characters that are easy to access on the keyboard.
 
 ## Installation
-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.
+Run `make install` as root to install  
+Run `make uninstall` as root to remove. Will not delete your personal charfiles
 
 ## Dependencies
-  * Posix shell  
+  * bash
   * util-linux  
   * xclip  
   * A terminal with UTF-8 encoding enabled  
@@ -31,6 +30,3 @@ Fill it in, using the provided examples as a template. Hidden shortcuts go above
 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