Skip to content

Commit faede7e

Browse files
committed
Updates to documentation in README.md.
1 parent 0403a26 commit faede7e

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ Next, create a file that will contain your aliases (if you aren't using one alre
1919
$ touch ~/.aliases
2020

2121
Add the following to a startup script such as `.bashrc` (or `.zshrc` if you are on `macOS`):
22-
22+
2323
export ALIASES_FILE=~/.aliases
2424
source $ALIASES_FILE
2525

2626
# Necessary if you don't want to restart your current session for changes to take effect.
2727
aliaser () {
2828
command aliaser "$@"
29-
if [ $? -eq 0 ]; then
29+
if [ $? -eq 0 ]; then
3030
if [ $1 = "add" ]; then
3131
source $ALIASES_FILE
3232
elif [ $1 = "rm" ]; then
@@ -40,6 +40,7 @@ Ensure that you source the updated `.bashrc` (or `.zshrc` if you went that route
4040
$ source ~/.bashrc
4141

4242
## Usage
43+
4344
Running `aliaser help` displays the following:
4445

4546
Tool for managing bash/zsh aliases
@@ -50,11 +51,11 @@ Running `aliaser help` displays the following:
5051
ls
5152
Lists all aliases saved in the aliases file, in alphabetical order
5253

53-
add <alias> <command>
54+
add <alias_name> <command>
5455
Creates/replaces an alias for the specified command in the aliases file
5556
The alias name must not contain any spaces, and can only consist of alphanumeric characters
5657

57-
rm <alias>
58+
rm <alias_name>
5859
Removes the alias permanently from the aliases file
5960
The alias name must not contain any spaces
6061

@@ -69,4 +70,5 @@ Running `aliaser help` displays the following:
6970
Note that this tool only manages aliases stored within the aliases file, any declared outside will not be affected.
7071

7172
## Demo
73+
7274
![Demo](demo.gif)

0 commit comments

Comments
 (0)