Commit 9c392334 authored by Adam Harrison-Fuller's avatar Adam Harrison-Fuller
Browse files

Readme updates



Signed-off-by: default avatarAdam Harrison-Fuller <adam@adamhf.io>
parent 74a645a3
...@@ -14,10 +14,11 @@ feeds: ...@@ -14,10 +14,11 @@ feeds:
feed_url: http://example.com/rss.xml // The Feed URL. feed_url: http://example.com/rss.xml // The Feed URL.
name: Test Feed // A User friendly display name. name: Test Feed // A User friendly display name.
gitlab_project_id: 12345 // The Gitlab project ID to create issues under. gitlab_project_id: 12345 // The Gitlab project ID to create issues under.
added_since: "2019-03-27T15:00:00Z" // (Optional) For longer RSS feeds specify a date to exclude items published/updated earlier than this added_since: "2019-03-27T15:00:00Z" // (Optional) For longer RSS feeds specify a ISO 8601 DateTime to exclude items published/updated earlier than this
labels: // (Optional) A list of labels to add to created Issues. labels: // (Optional) A list of labels to add to created Issues.
- TestLabel - TestLabel
- id: ... - id: feed2
...
``` ```
## Docker ## Docker
...@@ -36,4 +37,7 @@ that is contained within it stores the state of which RSS items have already bee ...@@ -36,4 +37,7 @@ that is contained within it stores the state of which RSS items have already bee
### Run it ### Run it
```sh ```sh
docker run -e GITLAB_API_TOKEN=<INSERT_TOKEN> -e DATA_DIR=/data -e CONFIG_DIR=/app -v <PATH_TO_DATA_DIR>:/data -v <PATH_TO_CONFIG_DIR>/config adamhf/rss-sync:latest docker run -e GITLAB_API_TOKEN=<INSERT_TOKEN> -e DATA_DIR=/data -e CONFIG_DIR=/app -v <PATH_TO_DATA_DIR>:/data -v <PATH_TO_CONFIG_DIR>/config adamhf/rss-sync:latest
``` ```
\ No newline at end of file
### TODO
* Make the retroactive setting of the Gitlab creation time optional.
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment