added documentation (not done yet)

This commit is contained in:
Bofh 2021-02-09 22:32:11 +01:00
parent 2c60e2102a
commit 09e46d498f
1 changed files with 24 additions and 0 deletions

24
README.md Normal file
View File

@ -0,0 +1,24 @@
# Instagram -> Pixelfed Mirror in Python (3+)
This Python scripts with a simple HTTP API to use it, can **mirror multiple accounts from Instagram to your Pixelfed** instance.
## Pre-requesites
- You **need an Instagram account** to make this bot work.
- **A Pixelfed instance** you own. It must be hosted or managed by you (you need shell access for **php artisan commands**)
- **Python 3+ installed** on the same machine as the Pixelfed instance (this is easy, mostly all standard Debian based Linux systems have python3)
- **Patch 1 file** on Pixelfed deployed code (being on docker or not)
## What can you mirror?
- Posts with **images** (multiple images support).
- Posts with **videos** (only 1 video).
- Each **posts captions** (post description) is **represented as splitted comments**.
## What can't you mirror (yet) ?
- **Stories**. (will support that soon)