Merge pull request #27 from lildude/more-docs

Add more to the docs
lildude · Mar 6, 2021 · fed9b1d · fed9b1d
2 parents 794dc20 + d52b0e6
commit fed9b1d
Showing 1 changed file with 15 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -4,18 +4,32 @@
 
 A Micropub server that accepts [Micropub](http://micropub.net/) requests and creates and publishes a Jekyll/GitHub Pages post to a configured GitHub repository. This server supports posting to multiple sites from the same server. This project is inspired by [Micropub to GitHub](https://github.com/voxpelli/webpage-micropub-to-github), a Node.js implementation.
 
+# Installation
+
 ## Run on Heroku
 
 Fork this repo (optional), [configure](#configuration) and then clicky this button :point_right: [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
 
-## Running Elsewhere or Locally
+## Run Elsewhere or Locally
 
 Clone the repository and run `bundle install`.
 
 Run `GITHUB_ACCESS_TOKEN="your_personal_access_token" bundle exec rackup` and you'll have the application running on <http://localhost:9292> .
 
 Alternatively, create an `env.rb` file in the root of this repository containing: `ENV['GITHUB_ACCESS_TOKEN'] = 'your_personal_access_token'`.
 
+## Endpoint Discovery
+
+Once deployed, your Micropub endpoint can be found at `/micropub/<sitename>` e.g. `https://example.com/micropub/mysite`.
+`<sitename>` is the site-specific section on your `config.yml` file.
+
+To enable automatic discovery for your [Micropub endpoint](https://indieweb.org/micropub#Endpoint_Discovery) and [token endpoint](https://indieweb.org/obtaining-an-access-token#Discovery), you will need to add the following values to your site's `<head>`:
+
+```html
+<link rel="micropub" href="https://example.com/micropub/mysite">
+<link rel="token_endpoint" href="https://tokens.indieauth.com/token">
+```
+
 ## Configuration
 
 Copy `config-example.yml` to `config.yml` and customise to your :heart:'s content. See the [configuration docs](docs/configuration.md) for full details.