From a4f020fb8c52e31b0abb284211746720df78e14a Mon Sep 17 00:00:00 2001 From: Chris Manson Date: Tue, 1 May 2018 19:14:08 +0100 Subject: [PATCH] updating documentation --- .travis.yml | 2 +- README.md | 10 ++++++++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index e44e8b2..12e7c76 100644 --- a/.travis.yml +++ b/.travis.yml @@ -12,7 +12,7 @@ node_js: env: global: - - CC_TEST_REPORTER_ID=0fc59b200a73fa77ebdb522da5a93cf50f11f50378dc1bddeea3e2a38b5f9f4e + - CC_TEST_REPORTER_ID=10ca3ddfc7f3a60104ec6b7d7da0aa23acaa5caa252c7257c06d19f46b5acb00 before_script: - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter diff --git a/README.md b/README.md index 01121df..d72b7ef 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ [![Build Status](https://travis-ci.org/stonecircle/express-autoroute-json.svg?branch=master)](https://travis-ci.org/stonecircle/express-autoroute-json) [![dependencies Status](https://david-dm.org/stonecircle/express-autoroute-json/status.svg)](https://david-dm.org/stonecircle/express-autoroute-json) [![devDependencies Status](https://david-dm.org/stonecircle/express-autoroute-json/dev-status.svg)](https://david-dm.org/stonecircle/express-autoroute-json?type=dev) -[![Maintainability](https://api.codeclimate.com/v1/badges/6a18031f88d7a4a2dd8f/maintainability)](https://codeclimate.com/repos/57a89b665a0b980c9200543d/maintainability) -[![Test Coverage](https://api.codeclimate.com/v1/badges/6a18031f88d7a4a2dd8f/test_coverage)](https://codeclimate.com/repos/57a89b665a0b980c9200543d/test_coverage) +[![Maintainability](https://api.codeclimate.com/v1/badges/3f269374a4293505f284/maintainability)](https://codeclimate.com/github/stonecircle/express-autoroute-json/maintainability) +[![Test Coverage](https://api.codeclimate.com/v1/badges/3f269374a4293505f284/test_coverage)](https://codeclimate.com/github/stonecircle/express-autoroute-json/test_coverage) # Express-Autoroute-JSON - automatically define your JSON:API backend @@ -139,6 +139,12 @@ module.exports.autoroute = autorouteJson({ }); ``` +## Further Documentation + +We are in the process of developing some more in-depth documentation (including courses) as part of the [Authmaker](https://authmaker.com) Curriculum. As I said above you **do not** need to use Authmaker if you want to to use express-autoroute-json, however the current [Authmaker documentation](https://beginner-guides.authmaker.com/current/index) is the most complete documentation of using this entire system in a full-stack application. + +There is a tiny bit more documentation on the [wiki](https://github.com/stonecircle/express-autoroute-json/wiki) but if you have any questions or want to request some specific documentation you can reach out to me [on Twitter](https://twitter.com/real_ate) + # Licence Copyright (c) 2018, Stone Circle