From 7a4ac45e078cf16b8800935002e0196bfc967040 Mon Sep 17 00:00:00 2001 From: Levi Date: Mon, 31 Oct 2022 21:06:12 +0100 Subject: [PATCH] feat: Description and information. --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e6fabb6..44d896c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,9 @@ -# ass-iOS-Media-Uploader -iOS Shortcut to upload images, gifs and videos to a ShareX ass server. +# [tycrek/ass](https://github.com/tycrek/ass) iOS Media Uploader + +This iOS/Siri Shortcut uploads your media (images, videos & gifs) to your [ass](https://github.com/tycrek/ass) server (an open source [ShareX](https://github.com/ShareX/ShareX) media hosting server). + +The shortcut requires configuration, which you will be prompted to do on import. You will be asked for the URL to your ass instance as well as the [auth token](https://github.com/tycrek/ass#generating-new-tokens) required to upload files to the server. At this step you can pass any other headers you'd like (instructions available in the ass [README.md](https://github.com/tycrek/ass#header-overrides)). + +Either start the shortcut from your share sheet or the shortcuts app, in which case you will be prompted to select media from your Photos gallery. + +If successful, the shortcut will place the URL to your shared file in your clipboard.