update readme, fix -n bug, remove branding

[charsel.git] / README.md

diff --git a/README.md b/README.md
index f0a7f3fe5b5dfad157b2588f97447d631cbaf155..91724a207b71c986a33fa3e04e3cc02a233615a8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,11 @@
-# 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
 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` 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
 
 - Run `make purge` to remove charsel files from your home directory
 - Run `make install-completions` to install the shell completions
 


@@ -13,7 +13,7 @@ It uses a plain-text file known as a "charfile" to define easy to reach shortcut
   * Bash
   * Linux
   * Xclip (using the -n flag bypasses this)
   * Bash
   * Linux
   * Xclip (using the -n flag bypasses this)

-  * A terminal with UTF-8 encoding enabled (most desktop environment's default terminal will be fine)
+  * A terminal with UTF-8 encoding enabled (most default terminals will be fine)

 
 ## Usage
 For argument usage, use `charsel -h`
 
 ## Usage
 For argument usage, use `charsel -h`


@@ -26,11 +26,10 @@ Some of the default charfiles have hidden shortcuts for capital letters that are
 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 in your shortcodes, using the provided examples in `/usr/share/charsel/charfiles` as a template. There are just 4 rules to follow.
 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 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. Shortcodes may not contain ";" (semicolon) as that is used to quit the program
-  5. Shortcodes cannot start with - as that confuses grep
+  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
 Copyright Armaan Bhojwani 2020, MIT License, see the LICENSE file for more information
 
 ## License
 Copyright Armaan Bhojwani 2020, MIT License, see the LICENSE file for more information