update Docs

This commit is contained in:
horhik 2021-11-14 23:17:45 +03:00
parent e35b400819
commit 88e344a9f7
1 changed files with 19 additions and 2 deletions

21
Docs.md
View File

@ -1,8 +1,24 @@
# Instagram2Fedi Docs # Instagram2Fedi Docs 📜
## Command line arguments ## How to use
You can use Instagram2Fedi via docker or just like a python scrip
### Via Docker
Specify your variables in `./env.sh` and then run `./run.sh`
You can modify `docker run` arguments in `./run.sh`
### Just a python script
Run `pip3 install -r requirements.txt` and then run `./insta2fedi`.
Specify your arguments. You should use `--use-docker 0`.
## Command line arguments
`--use-mastodon` - set not positive number (`0`, `-1`...) if your instance don't have max image count limit. `--use-mastodon` - set not positive number (`0`, `-1`...) if your instance don't have max image count limit.
For example, default maximum photo count in mastodon is `4` For example, default maximum photo count in mastodon is `4`
`--instance` - Your instance url `--instance` - Your instance url
@ -14,6 +30,7 @@ For example, default maximum photo count in mastodon is `4`
`--check-interval` - Interval in seconds how often to check for new posts `--check-interval` - Interval in seconds how often to check for new posts
`--post-interval` - Interval in seconds between new fetched posts. `--post-interval` - Interval in seconds between new fetched posts.
If theres more than one new post, sets with which time interval should it post them If theres more than one new post, sets with which time interval should it post them
`--fetch-count` - How many new posts to select `--fetch-count` - How many new posts to select