Merge pull request #100 from concourse/issue/95

clarify release/pre_release in README

README.md

@@ -26,20 +26,27 @@ Fetches and creates versioned GitHub resources.
 * `insecure`: *Optional. Default `false`.* When set to `true`, concourse will allow
   insecure connection to your github API.
 
-* `release`: *Optional. Default `true`.* When set to `true`, `put` produces
-  release and `check` detects releases.  If `false`, `put` and `check` will ignore releases.
-  Note that releases must have semver compliant tags to be detected.
-
-* `pre_release`: *Optional. Default `false`.* When set to `true`, `put` produces
-  pre-release and `check` detects prereleases. If `false`, only non-prerelease releases
-  will be detected and published. Note that releases must have semver compliant
-  tags to be detected.
-  If `release` and `pre_release` are set to `true`, `put` produces
-  release and `check` detects prereleases and releases.
+* `release`: *Optional. Default `true`.* When set to `true`, `check` detects
+  final releases and `put` publishes final releases (as opposed to
+  pre-releases). If `false`, `check` will ignore final releases, and `put` will
+  publish pre-releases if `pre_release` is set to `true`
+
+* `pre_release`: *Optional. Default `false`.* When set to `true`, `check`
+  detects pre-releases, and `put` will produce pre-releases (if `release` is
+  also set to `false`). If `false`, only non-prerelease releases will be detected
+  and published.
+
+  **note:** if both `release` and `pre_release` are set to `true`, `put`
+  produces final releases and `check` detects both pre-releases and releases. In
+  order to produce pre-releases, you must set `pre_release` to `true` and
+  `release` to `false`.  
+  **note:** if both `release` and `pre_release` are set to `false`, `put` will
+  still produce final releases.  
+  **note:** releases must have [semver compliant](https://semver.org/#backusnaur-form-grammar-for-valid-semver-versions) tags to be detected.
 
 * `drafts`: *Optional. Default `false`.* When set to `true`, `put` produces
   drafts and `check` only detects drafts. If `false`, only non-draft releases
-  will be detected and published. Note that releases must have semver compliant
+  will be detected and published. Note that releases must have [semver compliant](https://semver.org/#backusnaur-form-grammar-for-valid-semver-versions)
   tags to be detected, even if they're drafts.
 
 * `tag_filter`: *Optional.* If set, override default tag filter regular