Skip to content

Commit

Permalink
Updated README to include syndication details
Browse files Browse the repository at this point in the history
  • Loading branch information
am1t committed Aug 19, 2018
1 parent 163d34b commit 3b1a917
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Currently, the endpoint supports the following.
* Metadata creation for tags, slugs and published date
* Support for [like](https://indieweb.org/like) and [reply](https://indieweb.org/reply) post types. Added as metadata `like-of` and `in-reply-to`.
* Uploading of image files as `multipart` data. Added as metadata `photo`
* Support for syndicating posts to Mastodon

## TODO
* [ ] Implement repost, bookmark post types
Expand Down Expand Up @@ -51,7 +52,10 @@ Variable | Description
`MICRO_POST_PATH` | (Optional) Dropbox `path` where micro posts are to be stored. Default to `POST_PATH`
`SET_DATE` | (Optional) A `boolean` flag which if set to `true`, date of the post creation is explicitly added to post metadata
`TZ` | (Optional - only if `SET_DATE` set) By default, post creation date would be in `UTC`. This can be overridden by setting this to the preferred timezone using the [TZ Database Timezone format](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
`DEFAULT_TAG` | (Optional) If this property is set and no category is provided, value would be set as the tag
`DEFAULT_TAG` | (Optional) If this property is set and no category is provided, value would be set as the tag
`SYNDICATE_TO` | (Optional) Syndication target(s) provided as a JSON array. E.g. as defined at [spec](https://www.w3.org/TR/micropub/#syndication-targets): [{"uid":"https://social.example/johndoe","name":"@johndoe on Example Social Network"}]
`MASTODON_INSTANCE` | (Optional) Mastodon instance where posts need to be syndicated
`MASTODON_TOKEN` | (Optional) Access Token for Mastodon

## Modules used
* [micropub-express](https://github.com/voxpelli/node-micropub-express) – an [Express](http://expressjs.com/) Micropub endpoint that accepts and verifies Micropub requests and calls a callback with a parsed `micropubDocument`.
Expand Down
16 changes: 16 additions & 0 deletions app.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,22 @@
"description": "Overide default timezone for dates to the preferred one",
"required": false
},
"DEFAULT_TAG": {
"description": "Define default tags for posts with no tags",
"required": false
},
"SYNDICATE_TO": {
"description": "Syndication target(s). Provided as a JSON array.",
"required": false
},
"MASTODON_INSTANCE": {
"description": "Mastodon instance where posts need to be syndicated",
"required": false
},
"MASTODON_TOKEN": {
"description": "Access Token for the Mastodon",
"required": false
}
},
"buildpacks": [
{
Expand Down

0 comments on commit 3b1a917

Please sign in to comment.