summaryrefslogtreecommitdiff
path: root/views/docs.php
diff options
context:
space:
mode:
authorAaron Parecki <aaron@parecki.com>2017-01-06 11:00:34 -0800
committerAaron Parecki <aaron@parecki.com>2017-01-06 11:00:34 -0800
commit92615f6183c94c039d7591068768ae21ce6e0b11 (patch)
tree8eaf8a6a0a25eca5ee5c4a66f0b28cbffabca168 /views/docs.php
parentbdff359178d6696d1934a3e350d6cd1b33282251 (diff)
expand documentation
Diffstat (limited to 'views/docs.php')
-rw-r--r--views/docs.php67
1 files changed, 0 insertions, 67 deletions
diff --git a/views/docs.php b/views/docs.php
deleted file mode 100644
index 7c6757d..0000000
--- a/views/docs.php
+++ /dev/null
@@ -1,67 +0,0 @@
-<div class="narrow">
- <?= partial('partials/header') ?>
-
- <h2 id="introduction">Introduction</h2>
-
- <div class="col-xs-6 col-md-4" style="float: right;">
- <span class="thumbnail"><img src="/images/quill-ui.png"></span>
- </div>
-
- <p>This is a simple <a href="http://indiewebcamp.com/micropub">Micropub</a> client for
- creating text posts on your own website. To use it, you will need to turn your website
- into an OAuth provider, and implement a Micropub endpoint that this app will send
- requests to.</p>
-
- <p>Once you've signed in, you'll see an interface like the one shown which you can use to
- write a post. Clicking "post" will make a Micropub request to your endpoint.<p>
-
-
-
- <h2 id="endpoints">Configuring Endpoints</h2>
-
- <h3>Authorization Endpoint</h3>
- <?= partial('partials/auth-endpoint-help') ?>
-
- <h3>Token Endpoint</h3>
- <?= partial('partials/token-endpoint-help') ?>
-
- <h3>Micropub Endpoint</h3>
- <?= partial('partials/micropub-endpoint-help') ?>
-
- <p>The <a href="/creating-a-micropub-endpoint">Creating a Micropub Endpoint</a> tutorial will walk you through how to handle incoming POST requests from apps like this.</p>
-
-
-
- <h2 id="syndication">Syndication Targets</h2>
-
- <p>You can provide a list of supported <a href="https://www.w3.org/TR/micropub/#syndication-targets">syndication targets</a> that will appear as checkboxes when you are creating a new post.</p>
-
- <p>To do this, your Micropub endpoint will need to respond to a GET request containing a query string of <code>q=syndicate-to</code>. This request will be made with the access token that was generated for this app, so you can choose which syndication targets you want to allow this app to use.</p>
-
- <p>Below is the request and expected response that Quill looks for.</p>
-
- <pre><code>GET /micropub?q=syndicate-to HTTP/1.1
-Authorization: Bearer xxxxxxxxxx
-
-HTTP/1.1 200 OK
-Content-type: application/json
-
-{
- "syndicate-to": [
- {
- "uid": "https://twitter.com/aaronpk",
- "name": "twitter.com/aaronpk"
- },
- {
- "uid": "https://news.indieweb.org/en",
- "name": "IndieNews"
- }
- ]
-}
-</code></pre>
-
- <p>The specific values of names and uids are up to your Micropub endpoint, but a good convention is to use the domain name of the service (e.g. https://twitter.com), or domain name and username (e.g. https://twitter.com/aaronpk) for the uid, and a friendly name like "Twitter" or "twitter.com/aaronpk" as the name.</p>
-
- <p>Quill will check for your supported syndication targets when you sign in, but there is also a link on the new post screen to manually re-check if you'd like.</p>
-
-</div>