From 8d17d14736855699c4f9ba5d5bcb4436e45da481 Mon Sep 17 00:00:00 2001
From: raynor <hausofraynor@gmail.com>
Date: Sun, 18 Dec 2022 19:41:52 -0500
Subject: [PATCH] Updated readme. Didn't proofread. Might meed more.

---
 readme.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 49 insertions(+), 2 deletions(-)

diff --git a/readme.md b/readme.md
index 1b581a8..87faf08 100644
--- a/readme.md
+++ b/readme.md
@@ -18,8 +18,55 @@ If you want the full on public feed from an instance, put it in the domains-fede
 
 If you only want the local feed from an instance, put it on the domains-local file, one domain per line
 
-If you want to follow a hashtag you're out of luck because I didn't get that far. But it will go into the hashtags file.
+If you want to follow a hash tag you either either add a hashtag after an instance in `domains-federated` or `domains-local`
 
+For example: if in `domains-fedarated` you put `mastodon.social #JohnMastodon` a stream will open to watch for the hashtag #JohnMastodon on the public
+stream from mastodon.social
+
+Another example:  if in `domains-local` you put `infosec.exchange #hacker` a stream will open to watch for the hashtag #hacker on the _local_ stream from infosec.exchange
+
+## Docker
 Build docker
 
-Run docker
\ No newline at end of file
+Run docker
+
+### The hashtags file
+If you put ANY hashtags in here a stream will be opened for _every_ host in the `domains-federated` and `domains-local` file.
+
+Example:
+`domains-federated` content:
+
+```
+mastodon.social
+mas.to
+```
+
+`domains-local` content:
+
+```
+aus.social
+mastodon.nz
+```
+
+`hashtags` content:
+```
+JohnMastodon
+Mastodon
+```
+
+will result in the following streams all opening:
+```shell
+https://mastodon.social/api/v1/streaming/hashtag?tag=JohnMastodon
+https://mas.to/api/v1/streaming/hashtag?tag=JohnMastodon
+https://aus.social/api/v1/streaming/hashtag?tag=JohnMastodon
+https://mastodon.nz/api/v1/streaming/hashtag?tag=JohnMastodon
+https://mastodon.social/api/v1/streaming/hashtag?tag=Mastodon
+https://mas.to/api/v1/streaming/hashtag?tag=Mastodon
+https://aus.social/api/v1/streaming/hashtag?tag=Mastodon
+https://mastodon.nz/api/v1/streaming/hashtag?tag=Mastodon
+```
+
+If you had a total of 5 lines in `domains-federated` and `domains-local` plus 3 entries in `hashtags`
+there would 5x5x3 = 75 new streams.
+
+I mean, you can do it, but you won't need your central heating system any more.
\ No newline at end of file