From 5b9cf3e0d26175b4a6f9b537e5bc815ce9a17e10 Mon Sep 17 00:00:00 2001
From: Johanna Larsson <johanna.a.m.larsson@gmail.com>
Date: Thu, 2 Jul 2026 21:43:55 +0100
Subject: [PATCH] Update readme and add blog link

---
 README.md                                     | 19 +++++++++++++++----
 .../controllers/page_html/home.html.heex      |  7 +++++++
 2 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 79260fe..ee06384 100644
--- a/README.md
+++ b/README.md
@@ -4,18 +4,29 @@
 
 A service for automatically publishing content to the Atmosphere, using the standard.site lexicon. Register your publication and a discovery mechanism, and your content is automatically published.
 
-Requires your site to have a `link rel=alternate` for a feed set, and that you're able to verify your ownership by serving a `/.well-known` file.
+Stay up to date on development at [blog.annot.at](https://blog.annot.at).
 
-Document rkeys are derived from the post `<link rel="site.standard.document" href="<aturi>"`, so your blog must set that up. Document rkeys have to be TIDs to be valid, and should be stable, so either generate them and store them in your blog post fronmatter/metadata, or use a deterministic implementation that can run multiple times for the same post and give the same result.
+## How it works
+
+[annot.at](https://annot.at) enables you to log in using your atproto account, whether that's Bluesky, Eurosky, or your own PDS. it will ask for permission to write to the standard.site lexicon on your behalf.
+
+The app uses a few different things from your blog to accomplish this, and it requires some setup:
+
+1. During the site setup wizard we generate a record key for your publication if you don't have one yet, you will get instructions to host this key in your site under `/.well-known/site.standard.publication`.
+2. You need a well-formed RSS or Atom feed that contains your posts.
+3. Each page that you want to upload needs to have a `<link rel="site.standard.document" href="<at-uri>"` field set, this is what eg Bluesky uses to validate the standard.site document.
+
+Document rkeys have to be TIDs to be valid, and need to be stable, so either generate them and store them in your blog post fronmatter/metadata, or use a deterministic implementation that can run multiple times for the same post and give the same result.
+
+annot.at will use information from your blog to publish your documents. From the feed it gets title, description, content, tags, and published_at. From the blog post page itself it gets the open graph image and the record key.
 
 ## TODO
 
 - [x] Sign up/sign in with Bluesky
 - [x] Maybe some design?
 - [x] Add site including verification
-- [ ] Write a guide for using this
 - [x] Document cover images
-- [ ] Document content with html content type
+- [x] Document content with html content type
 - [ ] RSS poller
 - [ ] standard.site document reader
 - [ ] Post to Bluesky
diff --git a/lib/annot_at_web/controllers/page_html/home.html.heex b/lib/annot_at_web/controllers/page_html/home.html.heex
index 0b2195f..2d7f628 100644
--- a/lib/annot_at_web/controllers/page_html/home.html.heex
+++ b/lib/annot_at_web/controllers/page_html/home.html.heex
@@ -5,6 +5,13 @@
       <div class="mx-auto flex max-w-6xl items-center justify-between px-6 py-4">
         <a href="#top" class="font-display text-xl font-bold tracking-tight">annot.at</a>
         <div class="flex items-center gap-6">
+          <a
+            href="https://blog.annot.at"
+            class="hidden text-sm text-ink/70 transition hover:text-ink sm:inline underline decoration-accent decoration-2 underline-offset-4"
+          >
+            Blog
+          </a>
+
           <a href="#how" class="hidden text-sm text-ink/70 transition hover:text-ink sm:inline">
             How it works
           </a>
-- 
2.51.2