Merge pull request #5 from linuxserver/readme

add info on nightly tag

README.md

@@ -56,6 +56,14 @@ The architectures supported by this image are:
 | arm64 | arm64v8-latest |
 | armhf | arm32v7-latest |
 
+## Version Tags
+
+This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
+
+| Tag | Description |
+| :----: | --- |
+| latest | Stable Mylar3 releases |
+| nightly | Commits to Mylar3 `python3-dev` branch |
 
 ## Usage
 
@@ -148,7 +156,7 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
 ## Application Setup
 
 The web ui for settings etc, is on `<your-ip>:8090`
-For more detailed setup refer [Mylar3](https://github.com/mylar3/mylar3).
+For more detailed setup options, refer to [Mylar3](https://github.com/mylar3/mylar3).
 
 
 ## Docker Mods
@@ -222,4 +230,5 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
 
 ## Versions
 
+* **21.12.20:** - Release `nightly` tag based on commits to upstream `python3-dev` branch.
 * **28.09.20:** - Initial release.

readme-vars.yml

@@ -13,6 +13,12 @@ available_architectures:
   - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
   - { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}
 
+# development version
+development_versions: true
+development_versions_items:
+  - { tag: "latest", desc: "Stable Mylar3 releases" }
+  - { tag: "nightly", desc: "Commits to Mylar3 `python3-dev` branch" }
+
 # container parameters
 param_container_name: "{{ project_name }}"
 param_usage_include_vols: true
@@ -30,8 +36,9 @@ param_ports:
 app_setup_block_enabled: true
 app_setup_block: |
   The web ui for settings etc, is on `<your-ip>:8090`
-  For more detailed setup refer [{{ project_name|capitalize }}]({{ project_url }}).
+  For more detailed setup options, refer to [{{ project_name|capitalize }}]({{ project_url }}).
 
 # changelog
 changelogs:
+  - { date: "21.12.20:", desc: "Release `nightly` tag based on commits to upstream `python3-dev` branch."}
   - { date: "28.09.20:", desc: "Initial release."}