From 2869946053dc7f6f739eca6618c26deb6a3101d5 Mon Sep 17 00:00:00 2001
From: Dave Lane <dave@oerfoundation.org>
Date: Mon, 18 Dec 2023 23:04:05 +1300
Subject: [PATCH] moved RoadMap to RoadMap.md and improved Auth example
 formatting

---
 AuthNotes.md          | 14 ++++++++++----
 README.md             |  8 +++++++-
 RoadMap => RoadMap.md |  0
 3 files changed, 17 insertions(+), 5 deletions(-)
 rename RoadMap => RoadMap.md (100%)

diff --git a/AuthNotes.md b/AuthNotes.md
index 371c049..480b1ba 100644
--- a/AuthNotes.md
+++ b/AuthNotes.md
@@ -12,8 +12,15 @@ ref: https://docs.joinmastodon.org/client/token/#app
 
 ### Step 1 - Get Client info
 
-sent: 
-`curl -X POST -F 'client_name=Mastodon Map' -F 'redirect_uris=urn:ietf:wg:oauth:2.0:oob' -F 'scopes=read write push' -F 'website=https://mastomap.magnificent.nz' https://mastodon.nzoss.nz/api/v1/apps`
+sent:
+```
+curl -X POST \
+  -F 'client_name=Mastodon Map' \
+  -F 'redirect_uris=urn:ietf:wg:oauth:2.0:oob' \
+  -F 'scopes=read write push' \
+  -F 'website=https://mastomap.magnificent.nz' \
+  https://mastodon.nzoss.nz/api/v1/apps`
+```
 
 response (json):
 ```
@@ -49,7 +56,7 @@ response (json):
 }
 ```
 
-### Step 3 - Verify Auth Token 
+### Step 3 - Verify Auth Token
 
 sent:
 ```
@@ -77,4 +84,3 @@ curl \
 ```
 
 and see MastoFollowers.json for the first 6 results (see limit=6 above).
-
diff --git a/README.md b/README.md
index 3e6ebb0..c4b15eb 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,9 @@
 # mastodon-userstats
 
-This will be a service that watches a mastodon user (or users) and records, over time, changes in their followers (who's (un)followed them) over time. Over time additional metrics will be included, like that ability to see posts made around times of significant follower changes. 
\ No newline at end of file
+This will be a service that watches a mastodon user (or users) and records, over time, changes in their followers (who's (un)followed them) over time. Over time additional metrics will be included, like that ability to see posts made around times of significant follower changes.
+
+For my plans with this app, see Roadmap.md
+
+For info on authenticating with Mastodon, see AuthNotes.md
+
+For sample Mastodon Follower data, see MastoFollowers.json
diff --git a/RoadMap b/RoadMap.md
similarity index 100%
rename from RoadMap
rename to RoadMap.md