Add README

This commit is contained in:
webb 2020-09-03 17:26:03 -04:00
parent 756af7cb6f
commit c7b93164e9
No known key found for this signature in database
GPG Key ID: 8B6F0D2784D22DB2
1 changed files with 17 additions and 0 deletions

17
README Normal file
View File

@ -0,0 +1,17 @@
interrupt -- a simple CLI for pxl.blue
--------------------------------------
This is fairly early, but more is planned (see the
issues to get an idea of what I plan on adding).
The upload key is read from the PXL_KEY environemnt
variable. It will read MIRAGE_KEY as a fallback in
case you're migrating from mirage.sh.
To upload a file, you can use the upload subcommand:
interrupt upload glenda.png
or you can read from STDIN using "-" as the filename:
curl https://example.com/test.png | interrupt upload -