From 79cf2a0d43ddda338487c85c420f67fe9c56687f Mon Sep 17 00:00:00 2001
From: Shundeev Egor <shundeevegor@gmail.com>
Date: Tue, 5 Jan 2021 19:46:05 +0300
Subject: fix(fastfile): fix multiple bugs in plugin (#9574)

- `fastfile_sync` didn't correctly create the aliases
- `fastfile_rm` didn't correctly remove the alias

Fixes #9151
Closes #9574
---
 plugins/fastfile/README.md | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

(limited to 'plugins/fastfile/README.md')

diff --git a/plugins/fastfile/README.md b/plugins/fastfile/README.md
index 37f5b2f53..32f619ffd 100644
--- a/plugins/fastfile/README.md
+++ b/plugins/fastfile/README.md
@@ -4,6 +4,7 @@ This plugin adds a way to reference certain files or folders used frequently usi
 a global alias or shortcut.
 
 To use it, add `fastfile` to the plugins array in your zshrc file:
+
 ```zsh
 plugins=(... fastfile)
 ```
@@ -13,36 +14,38 @@ plugins=(... fastfile)
 Example: you access folder `/code/project/backend/database` very frequently.
 
 First, generate a shortcut with the name `pjdb`:
+
 ```zsh
 $ fastfile pjdb /code/project/backend/database
 ```
 
 Next time you want to access it, use `§pjdb`. For example:
+
 ```zsh
 $ cd §pjdb
 $ subl §pjdb
 ```
+
 where § is the fastfile prefix (see [below](#options) for how to change).
 
 **Note:** shortcuts with spaces in the name are assigned a global alias
 where the spaces have been substituted with underscores (`_`). For example:
 a shortcut named `"hello world"` corresponds with `§hello_world`.
 
-
 ## Functions
 
-- `fastfile <shortcut_name> <path/to/file/or/folder>`: generate a shortcut.
+- `fastfile <shortcut_name> [path/to/file/or/folder]`: generate a shortcut.
+  If the second argument is not provided, the current directory is used.
 
 - `fastfile_print <shortcut_name>`: prints a shortcut, with the format
   `<prefix><shortcut_name> -> <shortcut_path>`.
 
 - `fastfile_ls`: lists all shortcuts.
 
-- `fastfile_rm <shortcut_name> `: remove a shortcut.
+- `fastfile_rm <shortcut_name>`: remove a shortcut.
 
 - `fastfile_sync`: generates the global aliases for the shortcuts.
 
-
 ### Internal functions
 
 - `fastfile_resolv <shortcut_name>`: resolves the location of the shortcut
@@ -51,7 +54,6 @@ a shortcut named `"hello world"` corresponds with `§hello_world`.
 
 - `fastfile_get <shortcut_name>`: get the real path of the shortcut.
 
-
 ## Aliases
 
 | Alias  | Function         |
@@ -62,7 +64,6 @@ a shortcut named `"hello world"` corresponds with `§hello_world`.
 | ffls   | `fastfile_ls`    |
 | ffsync | `fastfile_sync`  |
 
-
 ## Options
 
 These are options you can set to change certain parts of the plugin. To change
-- 
cgit v1.2.3-70-g09d2