From f73a377602cc7117b698c982d43343f24b7e6039 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Samy=20Pess=C3=A9?= Date: Thu, 17 Mar 2016 11:02:10 +0100 Subject: [PATCH] Add doc for atom feed --- README.md | 1 + docs/faq.md | 4 ++++ docs/urls.md | 8 +++++++- 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9aa66be6..152f6e29 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,7 @@ It uses GitHub as a backend to store assets, and it can easily be deployed to He - :sparkles: Release notes endpoint - `/notes/:version` - :sparkles: Up-to-date releases (GitHub webhooks) +- :sparkles: Atom/RSS feeds for versions/channels #### Deploy it / Start it diff --git a/docs/faq.md b/docs/faq.md index f1c71102..3d6a3a64 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -29,3 +29,7 @@ By default releases are tagged as 32-bits (except for OSX), but 64-bits will als ### How should I tag my releases? Nuts requires applications to follow [SemVer](http://semver.org). And even if you're not using Nuts, you should follow it! + +### Does nuts provide an Atom feed of versions? + +Yes, [See Feed URLS](./urls.md). diff --git a/docs/urls.md b/docs/urls.md index 58c6428c..b9da063a 100644 --- a/docs/urls.md +++ b/docs/urls.md @@ -1,4 +1,4 @@ -# Download urls +# Download Urls Nuts provides urls to access releases assets. These assets are cached on the disk. @@ -9,3 +9,9 @@ Nuts provides urls to access releases assets. These assets are cached on the dis * Specific channel: `http://download.myapp.com/download/channel/beta` * Specific channel for specific platform: `http://download.myapp.com/download/channel/beta/osx` +# Atom Feed Urls + +Nuts provides different Atom feeds: + +* All versions: `http://download.myapp.com/feed/channel/all.atom` +* Versions in specific channel: `http://download.myapp.com/feed/channel/:channel.atom`