From 92615f6183c94c039d7591068768ae21ce6e0b11 Mon Sep 17 00:00:00 2001 From: Aaron Parecki Date: Fri, 6 Jan 2017 11:00:34 -0800 Subject: expand documentation --- views/docs.php | 67 ---------------------------------------------------------- 1 file changed, 67 deletions(-) delete mode 100644 views/docs.php (limited to 'views/docs.php') 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 @@ -
- - -

Introduction

- -
- -
- -

This is a simple Micropub 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.

- -

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.

- - - -

Configuring Endpoints

- -

Authorization Endpoint

- - -

Token Endpoint

- - -

Micropub Endpoint

- - -

The Creating a Micropub Endpoint tutorial will walk you through how to handle incoming POST requests from apps like this.

- - - -

Syndication Targets

- -

You can provide a list of supported syndication targets that will appear as checkboxes when you are creating a new post.

- -

To do this, your Micropub endpoint will need to respond to a GET request containing a query string of q=syndicate-to. 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.

- -

Below is the request and expected response that Quill looks for.

- - 
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"
-    }
-  ]
-}
-
- -

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.

- -

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.

- -
-- cgit v1.2.3