diff --git a/README.md b/README.md index 422b8dc..a7d8722 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,22 @@ ### Simple Goto script written in cpp. -Usage: goto [OPTION|LINK_NAME] -Options: + Usage: goto [OPTION|LINK_NAME] + + Options: + -h --help : Show this info + -c --create_link : Create a new link e.g: goto --create_link [LINK_NAME] [FROM_PATH] + -l --list : List all the existing links + -d --delete_link : Delete an exisiting link e.g: goto -d [LINK_NAME] - -rf --delete_file : Delete the existing link file completely. + + -rf --delete_file : Delete the existing link file completely + [LINK_NAME] : Goes to an exisiting link e.g: goto [LINK_NAME] + [LINK_NAME] : Rules for creating [LINK_NAME] name must be BASH variable and must not start with "-" + [LINK_NAME] : [LINK_NAME] cannot be "last" ### To use add a function in bash like: