diff --git a/README.md b/README.md index 9a0d9e0..4ad103a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,14 @@ # syndicate -A simple implementation of the [P.O.S.S.E.](https://indieweb.org/POSSE) content publishing model. +A simple implementation of the [P.O.S.S.E.](https://indieweb.org/POSSE) content publishing model, packaged as a Github Action. Write your content, store it on Github, and use this action in a workflow to draft it to silo platforms like [DEV.to](https://dev.to). The action will keep the silos up to date with your latest changes here on Github. Wherever possible, when content is syndicated to a silo for the first time, it is created in an unpublished/"draft" form. Any exceptions to this will be called out in the documentation for [`silos`](#silos) below. +The silos currently supported are: +- https://dev.to + ## Example usage See [the example workflow](https://github.com/dabrady/syndicate/blob/develop/.github/workflows/example.yml) for a fully annotated example, but here's the quick version: @@ -52,7 +55,7 @@ with: If a given silo is unsupported, it will be ignored and called out in the action log. -The current supported silos are: +The silos currently supported are: - `DEV` (https://dev.to) ### `mark_as_syndicated`