Add doc for atom feed

msholly · Mar 17, 2016 · f73a377 · f73a377
1 parent e0c82dd
commit f73a377
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git 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
@@ -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
@@ -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`