From 09e46d498fa125ccc907a3bbc1d9d881adedd31d Mon Sep 17 00:00:00 2001 From: Bofh Date: Tue, 9 Feb 2021 22:32:11 +0100 Subject: [PATCH] added documentation (not done yet) --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..52aef09 --- /dev/null +++ b/README.md @@ -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) + +