diff --git a/README.md b/README.md index db46662..46719f6 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,35 @@ ## Description -Litterbox.catbox.moe is a publicaly accessbile temporary file host +Litterbox.catbox.moe is a publicly accessible temporary file host This script interacts with the API to upload a specified file for a specified amount of time +## Setup + +Place the script somewhere within your path, you can find this by running: + +``` bash +echo "$PATH" +``` + +After this make the script executable: + +``` bash +chmod u+x +``` + ## Usage -Place the script in your path, make it executable and type catboxuploader then the name of the file after +Type catboxuploader then the name of the file after, for example: -After this input the amount of hours you want the file to be uploaded for (1, 12, 24 or 72) +``` bash +catboxuploader 123.png +``` -Finally once the file has uploaded a shareable link to your file will be returned +After this you will be prompted to input the amount of hours you want the file to be uploaded for, (1, 12, 24 or 72) + +Finally once the file has uploaded a shareable link will be returned in the terminal ``` bash #!/bin/bash