Add setup instructions to README

This commit is contained in:
arne 2023-02-03 09:39:09 +01:00
commit 09e98663d0

View file

@ -1,9 +1,19 @@
# Mastodon Image Bot # 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] 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.