From b1dabbb16a69634ac0472306c473dd30b19380c6 Mon Sep 17 00:00:00 2001 From: Mauro George Date: Thu, 1 Oct 2015 18:55:26 -0300 Subject: [PATCH 1/2] Add link to docs on README [ci skip] --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 1f470dbc..35d066df 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,13 @@ Adapters describe _how_ attributes and relationships should be serialized. By default AMS will use the **Attributes Adapter**. But we strongly advise you to use **JsonApi Adapter** that follows 1.0 of the format specified in [jsonapi.org/format](http://jsonapi.org/format). Check how to change the adapter in the sections bellow. +# Documentation + +AMS has two main sets of documentation: the +[Docs](https://github.com/rails-api/active_model_serializers/tree/master/docs), +which is a comprehensive guide and in +[RDoc](http://www.rubydoc.info/github/rails-api/active_model_serializers) format. + # RELEASE CANDIDATE, PLEASE READ This is the master branch of AMS. It will become the `0.10.0` release when it's From 12f20ea2b8c329ec7a9a1242284631025342dd0f Mon Sep 17 00:00:00 2001 From: Benjamin Fleischer Date: Thu, 8 Oct 2015 14:00:30 -0500 Subject: [PATCH 2/2] Note docs are for master --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 35d066df..61cbf654 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,10 @@ Check how to change the adapter in the sections bellow. # Documentation -AMS has two main sets of documentation: the -[Docs](https://github.com/rails-api/active_model_serializers/tree/master/docs), -which is a comprehensive guide and in -[RDoc](http://www.rubydoc.info/github/rails-api/active_model_serializers) format. +Master + +- [![API Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/rails-api/active_model_serializers) +- [Guides](https://github.com/rails-api/active_model_serializers/tree/master/docs) # RELEASE CANDIDATE, PLEASE READ