Updated README.md

Author: fezcode

README.md

@@ -1,21 +1,20 @@
 # BM - Bookmark Manager
-## Your Shell Bookmark Manager.
+## A Simple Bookmark Manager for Your Shell.
 
 Creates `~/.bm` directory to store `store.toml` file which contains your bookmarks in
 `toml` format.
 
 ## Commands
-
-```bash
-bm a/add <name>                      : Adds current directory to bookmarks.
-bm a/add <name> <directory> [option] : Adds given directory to bookmarks.
-bm s/show                            : Show all bookmarks.
-bm s/show <name>                     : Show bookmark associated with given name.
-bm d/delete <name>                   : Delete bookmark with given name.
-bm h/help                            : Prints help text.
-bm -h/--help                         : Prints help text.
-bm debug <any full command>          : For any command, activates debug mode, if any debug prints are available.
-```
+| Command                                | Description                                                               |
+|:---------------------------------------|:--------------------------------------------------------------------------|
+| `bm a/add <name>                     ` | Adds current directory to bookmarks.                                      |
+| `bm a/add <name> <directory> [option]` | Adds given directory to bookmarks.                                        |
+| `bm s/show                           ` | Show all bookmarks.                                                       |
+| `bm s/show <name>                    ` | Show bookmark associated with given name.                                 |
+| `bm d/delete <name>                  ` | Delete bookmark with given name.                                          |
+| `bm h/help                           ` | Prints help text.                                                         |
+| `bm -h/--help                        ` | Prints help text.                                                         |
+| `bm debug <any full command>         ` | For any command, activates debug mode, if any debug prints are available. |
 
 ### Add Options
 ```
@@ -31,48 +30,96 @@ bm debug <any full command>          : For any command, activates debug mode, if
        
    -f, --file-only 
        Add bookmark if it is file only. If -d is provided last, -d will be used.
-       
 ```
 
 ### Show Options
-
 ```
    -p, --pretty
        When priting all files, via `bm show`, giving this option prints output
        in table format.
 ```
 
-## Building Project
+## Examples
+
+### 1. Add directory to bookmarks
+```bash
+# Add directory 
+$ bm a HOME_DIR ~ 
+# Add current directory
+$ bm a HOME_DIR 
+```
+
+### 2. Change directory to `HOME_DIR`
+**Linux**
+```bash
+$ cd `bm s HOME_DIR`
+# or
+$ cd $(bm s HOME_DIR)
+```
+
+**Windows**
+```bash
+$ cd $(.\bm s HOME_DIR)
+# or
+$ bm s HOME_DIR | cd
+```
+
+### 3. Show all bookmarks
+```bash
+$ bm s
+# or pretty print
+$ bm s -p
+```
 
+### 4. Delete bookmark
+```bash
+$ bm d HOME_DIR 
+```
+
+### 5. Add path to bookmarks if given path is path of a file
+```bash
+$ bm d FILE_PATH file.txt -f
+```
+
+### 6. Add path to bookmarks if given path is path of a directory
+```bash
+$ bm d DIR_PATH /path/to/dir -d
+```
+
+### 7. Print additional information via Debug command
+```bash
+$ bm debug add PATH /path
+```
+
+## Building Project
 In order to build project, run
 
 ```bash
-  cargo build
+$ cargo build
 ```
 
 To run project,
 
 ```bash
-    cargo run --package bm --bin bm
+$ cargo run --package bm --bin bm
 ```
 
 ## Creating Debian Package
-[Source](https://blog.karmacomputing.co.uk/how-to-create-deb-package-from-rust/)
-1. First install cargo-deb package 
+1. First install cargo-deb package
 ```bash
    cargo install cargo-deb 
 ```
 
 2. Add metadata to Cargo.toml
 ```toml
-
 [package.metadata.deb]
-maintainer = "Fezcode <samil.bulbul@gmail.com>"
-copyright = "Copyright (c) 2022 fezcode <samil.bulbul@gmail.com>"
-
+maintainer = "Username <username@example.com>"
+copyright = "Copyright (c) 2022 Username <username@example.com>"
 ```
 
 3. Run `cargo deb`
 ```
 cargo deb
-```
+```
+
+**_[Source](https://blog.karmacomputing.co.uk/how-to-create-deb-package-from-rust/)_**