From 18e986cf77a5434d224ac93484735ba4907e17ac Mon Sep 17 00:00:00 2001 From: manfromhuh Date: Tue, 19 Jul 2022 15:48:51 -0400 Subject: [PATCH] Add docs --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..95fcf58 --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +# url_unsafe + +Set urlsafe strings back to regularly formatted URLs. + +## Usage + +`url_unsafe https%3A%2F%2Fwww.facebook.com%2F` + +Output: + +`https://www.facebook.com/` + +## Output of -h + +``` +usage: url_unsafe [-h] [--version] [safe_string] + +Set urlsafe strings back to regularly formatted URLs. + +positional arguments: + safe_string The string to convert from urlsafe to a URL. + +options: + -h, --help show this help message and exit + --version, -v Print the current version number. +``` \ No newline at end of file