Trying to describe the chaos further

README.md

@@ -4,31 +4,39 @@
 
 A service to facilitate collective digital publishing practices.
 
-## Mapping out the pubspace
+## How does publishing happen?
 
-- **Services**:
+### cloud.lumbung.space
 
-  - [cloud.lumbung.space](https://cloud.lumbung.space/) ([Nextcloud](https://nextcloud.com/))
-  - [tv.lumbung.space](https://tv.lumbung.space/) ([Peertube](https://joinpeertube.org/))
-  - [social.lumbung.space](https://social.lumbung.space/) ([Hometown](https://github.com/hometown-fork/hometown))
-  - [lumbung.space](https://lumbung.space/) ([Hugo](https://gohugo.io/))
+> **WARNING**: Only file sharing is implemented
 
-- **Types of shares**:
+- When a file is tagged with the `publish` tag, a share link will be generated
+- This share link will be shown on the `publish.lumbung.space` prototype page
 
-  - **cloud.lumbung.space**: links to file paths
-  - **tv.lumbung.space**: links to videos
-  - **social.lumbung.space**: links to posts
+### social.lumbung.space
 
-- **Publishing flows**:
-  - **cloud.lumbung.space**: Using [Nextcloud flows](https://nextcloud.com/blog/nextcloud-flow-makes-it-easy-to-automate-actions-and-workflows/), we can trigger an outgoing HTTP request towards `pubspace`
-  - **tv.lumbung.space**: Using [a federation client](https://mastodonpy.readthedocs.io/) we can watch for specific hashtags to trigger publishing
-  - **social.lumbung.space**: Using [a federation client](https://mastodonpy.readthedocs.io/), we can watch for specific hashtags to trigger publishing
+- When a toot uses the hashtag `#pubspace` (a comment on a thread will also "unroll" the entire thread)
+- Only toots with `visibility: public` will be published. Local only posts and otherwise private posts are respected.
+- This toot link will be shown on the `publish.lumbung.space` prototype page
+
+### tv.lumbung.space
+
+- When someone comments on a published video using the `#pubspace` hashtag
+- This toot link will be shown on the `publish.lumbung.space` prototype page
+
+## Supported services
+
+- [cloud.lumbung.space](https://cloud.lumbung.space/) ([Nextcloud](https://nextcloud.com/))
+- [tv.lumbung.space](https://tv.lumbung.space/) ([Peertube](https://joinpeertube.org/))
+- [social.lumbung.space](https://social.lumbung.space/) ([Hometown](https://github.com/hometown-fork/hometown))
 
 ## Nextcloud flow script
 
-```bash
-echo "TODO"
-```
+See the [pubspace.sh](./pubspace.sh) script. This is manually copied over into
+`/var/www/html/pubspace/pubspace.sh` for now. There is a workflow scripts rule
+configured that when a file is tagged, the script is run. The script sends the filename
+to this service and then we use the [pyocclient](https://github.com/owncloud/pyocclient)
+to generate a share for that file. The Nextcloud crontab runs the script.
 
 ## Deployment