Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
M4cs authored Nov 8, 2019
1 parent 643c119 commit 3ead847
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,40 @@ Upsty is a tool that is inspired by https://transfer.sh which used to be nice to

The backend folder contains the Flask application running the service. This is a simple single file Flask app that utilizes a config file in `backend/config.json`. Before starting development make sure to set up all the information inside of that config file.


### Requirements:

- Flask
- boto3

### Running:

```
flask run
```

This will run a server on http://localhost:5000

# Command Line Tool

The command line tool is a `pip` program that you can install by running `pip install upsty`. This will remove the need for cURL and simply interfaces with the API on https://up.psty.io already.

### Usage:

```
usage: upsty [-h] filepath filename
positional arguments:
filepath Path to file for upload.
filename Filename to download as.
optional arguments:
-h, --help show this help message and exit
```

# Credit

Written by [@MaxBridgland] 2019
Written by Max Bridgland

# License

Expand Down

0 comments on commit 3ead847

Please sign in to comment.