README.md 1.38 KB
Newer Older
Nathanaël's avatar
Nathanaël committed
1
2
# MastoZap

Nathanaël's avatar
Nathanaël committed
3
__*Work in progress: this project doesn't work yet.*__
Nathanaël's avatar
Nathanaël committed
4

Nathanaël's avatar
Nathanaël committed
5
6
7
A [Zapier](https://zapier.com/) app for Mastodon alowing users to easily automate several tasks with their favorite social media.

The long-term idea is to write apps [for other federated projects](https://framagit.org/roipoussiere/MastoZap/wikis/home#apis-of-federated-projects) such as PeerTube or PixelFed.
Nathanaël's avatar
Nathanaël committed
8
9

Want to contribute? Thank! We have [a contribution guide](CONTRIBUTING.md) just for you!
Nathanaël's avatar
Nathanaël committed
10
11
12
13
14
15
16
17

## How it works?

The basic workflow of Zapier apps is *If this, then that*:

- several events on your Mastodon account can **trigger** many apps;
- many apps can execute **actions** on you Mastodon account.

Nathanaël's avatar
Nathanaël committed
18
📜 Some examples:
Nathanaël's avatar
Nathanaël committed
19

Nathanaël's avatar
Nathanaël committed
20
21
- **if** I publish some content on a Facebook page, **then** I send a toot on Mastodon*;
- **if** a bloger sends a content on a RSS feed, **then** I send a toot on Mastodon*;
Nathanaël's avatar
Nathanaël committed
22
23
24
- **if** I send a toot on Mastodon, **then** I send a tweet on Twitter;
- **if** I follow someone on Mastodon, **then** I follow someone on Mastodon (ie. for backup accounts).

Nathanaël's avatar
Nathanaël committed
25
__*__ Note that to send non-private toots, your account must be tagged as a bot. 🤖
Nathanaël's avatar
Nathanaël committed
26
27
28
29
30

This project is used to write the Zapier triggers and actions.

Based on them, you can easily write the user stories (*Zaps*) like below, or use user stories that are already available.

Nathanaël's avatar
Nathanaël committed
31
There are [a lot of apps](https://zapier.com/apps) available on Zapier, check it out!