From 09e98663d084a626756521339344debf51204778 Mon Sep 17 00:00:00 2001 From: arne Date: Fri, 3 Feb 2023 09:39:09 +0100 Subject: [PATCH] Add setup instructions to README --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 20f66a1..0563619 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,19 @@ # Mastodon Image Bot -This is a small program that posts an image from a given folder every time you call it. You can call it like so: +This is a small program that posts an image from a given folder every time you call it. + +## Setup + +- [Install deno](https://deno.land/manual@v1.30.1/getting_started/installation) +- Create a folder somewhere on your computer +- Fill the folder with images you'd like to post + +## Usage + +You can call it like so: ``` MASTODON_INSTANCE_URL=... MASTODON_ACCESS_TOKEN=... deno run --allow-env --allow-net --allow-write --allow-read main.ts [folder] ``` -If you leave out `folder` when calling the script, it will try to look for a `posts` directory inside the folder where the script is located. +It is best if you specify `folder` as an `/absolute/path/like/so`. If you leave out `folder` when calling the script, it will try to look for a `posts` directory inside the folder where the script is located.