README.md in easy_swagger_ui-0.1.1 vs README.md in easy_swagger_ui-0.1.2
- old
+ new
@@ -4,10 +4,12 @@
Test against Rails 5.x. Should also work with Rails 4.2.x.
Swagger UI version: 2.2.10. Accessible by in `EasySwaggerUi::SWAGGER_UI_VERSION`.
+[![Build Status](https://travis-ci.org/bianjp/easy_swagger_ui.svg?branch=master)](https://travis-ci.org/bianjp/easy_swagger_ui) [![Gem Version](https://badge.fury.io/rb/easy_swagger_ui.svg)](https://badge.fury.io/rb/easy_swagger_ui) [![Dependency Status](https://gemnasium.com/badges/github.com/bianjp/easy_swagger_ui.svg)](https://gemnasium.com/github.com/bianjp/easy_swagger_ui) [![Code Climate](https://lima.codeclimate.com/github/bianjp/easy_swagger_ui/badges/gpa.svg)](https://lima.codeclimate.com/github/bianjp/easy_swagger_ui)
+
## Features
* Parse API documentation in YAML files and serve as JSON to be consumed by Swagger UI
* separate your documentation into multiple YAML files for ease of management
* Support using ERB in YAML files
@@ -32,10 +34,10 @@
Mount it in `config/routes.rb`:
```
# Change the mount point as you like
-mount EasySwaggerUi::Engine => '/docs'
+mount EasySwaggerUi::Engine => 'docs'
```
### Write your API documentation
Your documentation should match the requirement of [Swagger Specification](http://swagger.io/specification/). See examples at [Swagger Online Editor](http://editor.swagger.io/).