From 321783cdcd0237d508889a201f74281baa5c6d52 Mon Sep 17 00:00:00 2001
From: Adam Harrison-Fuller <adam@adamhf.io>
Date: Thu, 28 Mar 2019 13:13:53 +0000
Subject: [PATCH] Adding parameter tables to the README
Signed-off-by: Adam Harrison-Fuller <adam@adamhf.io>
---
README.md | 30 +++++++++++++++++++++++-------
1 file changed, 23 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 048156a..390364c 100644
--- a/README.md
+++ b/README.md
@@ -21,18 +21,34 @@ The config file **MUST** be named config.yaml, an example one is provided [here]
description of its contents.
```yaml
-interval: 300 // Interval in seconds to check the RSS feeds.
+interval: 300
feeds:
- - id: test //Specify a feed ID that is used internally for duplicate detection.
- feed_url: http://example.com/rss.xml // The Feed URL.
- name: Test Feed // A User friendly display name.
- 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 ISO 8601 DateTime to exclude items published/updated earlier than this
- labels: // (Optional) A list of labels to add to created Issues.
+ - id: test
+ feed_url: http://example.com/rss.xml
+ name: Test Feed
+ gitlab_project_id: 12345
+ added_since: "2019-03-27T15:00:00Z"
+ labels:
- TestLabel
- id: feed2
...
```
+### Global
+| Attribute | Type | Required | Description |
+|-----------|------|----------|---------------------------------------------|
+| interval | int | yes | The interval in seconds between feed checks |
+
+### Feeds
+| Attribute | Type | Required | Description |
+|-------------------|--------|----------|-------------------------------------------------------------------------------------------------------|
+| id | string | yes | A feed ID that is used internally for duplicate detection. |
+| feed_url | string | yes | The URL of the feed |
+| name | string | yes | A User friendly display name. |
+| gitlab_project_id | int | yes | The Gitlab project ID to create issues under. |
+| added_since | string | no | For longer RSS feeds specify a ISO 8601 DateTime to exclude items published/updated earlier than this |
+| Labels | Array | no | A list of labels to add to created Issues |
+
+
## Docker
A Docker image is made available on [DockerHub](https://hub.docker.com/r/adamhf/gitlabrsssync)
--
GitLab