chore: update README

panaaj · Dec 13, 2020 · 2f1411a · 2f1411a
1 parent e1bb8f4
commit 2f1411a
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@
 
 - Add capability to define additional resource paths.
 
+- Serve list of available resource types on the server at `/signalk/v1/api/resources`.
+
 ### v1.2.1
 
 - Add validation when retrieving data from file storage.

diff --git a/README.md b/README.md
@@ -10,10 +10,20 @@ This Signal K node server plugin acts as a resource provider for the following r
 
 as well as allowing the user to define additional paths under `/signalk/v1/api/resources` to serve user provided resource data sets.
 
+- _example:_ `resources/fishing`   
+
 Each path is provisioned with `GET`, `PUT`, `POST` and `DELETE` operations enabled.
 
 Operation of all paths is as set out in the Signal K specification.
 
+---
+
+Additionally, the path `/signalk/v1/api/resources` will return an array of __ALL__ available resource paths on the server, not just the ones provided by the `sk-resources-fs` plugin.
+
+_Example:_
+```
+["buddies","routes","waypoints","notes","regions","tracks","fishing"]
+```
 ---
 ## Installation and Configuration: