From aa9218de275b7ed2c9d6cc9cf43ea115c20d2d86 Mon Sep 17 00:00:00 2001 From: Jeff Koch <4649003+jrkoch@users.noreply.github.com> Date: Mon, 29 Jan 2018 08:26:10 -0800 Subject: [PATCH] fix(docs): Update README to point users towards examples directory. (#36) --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1ae88b8..210c0cb 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,8 @@ You can also log in with a username and password or a previously-generated JWT t ## Documentation -Generated documentation is available on the [project page][project-page] +Generated documentation is available on the [project page][project-page]. You can also find example +usages in the [src/examples directory][src-examples]. ## Contributing @@ -37,3 +38,4 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for our guide to contributing and cod [project-page]: http://syncromatics.github.io/syncromatics-track-api [login-docs]: http://syncromatics.github.io/syncromatics-track-api#tracklogin [track-api-docs]: http://docs.syncromaticstrackapi.apiary.io +[src-examples]: https://github.com/syncromatics/syncromatics-track-api/tree/master/src/examples