update readme, fix -n bug, remove branding

[charsel.git] / README.md

diff --git a/README.md b/README.md
index c43697be2fe944cdb0b337601865ff9017d07eb7..91724a207b71c986a33fa3e04e3cc02a233615a8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,18 +1,19 @@
-# CHARSEL
+# 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
+- Run `make` as root to install
+- Run `make uninstall` as root to remove
+- Run `make purge` to remove charsel files from your home directory
+- Run `make install-completions` to install the shell completions
 
 ## Dependencies
   * Bash
   * Linux
-  * Xclip
-  * A terminal with UTF-8 encoding enabled
+  * Xclip (using the -n flag bypasses this)
+  * A terminal with UTF-8 encoding enabled (most default terminals will be fine)
 
 ## Usage
 For argument usage, use `charsel -h`
@@ -22,11 +23,13 @@ Once you have started the program, simply type the shortcut listed on the left s
 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.
+Make a new file in `~/.local/share/charsel/charfiles/` or `/usr/share/charsel/charfiles/` 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
+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 used is "shortcode,output"
+  2. Hidden shortcodes go above the line with "---"
+  3. Lines can be commented out using a "#"
+  4. Shortcodes may not contain a semicolon or a hyphen
 
 ## 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