README.md in fitting-2.16.1 vs README.md in fitting-2.17.0

- old
+ new

@@ -1,9 +1,22 @@ # Fitting -Coverage API Blueprint, Swagger and OpenAPI with rspec tests for easily make high-quality API and documenatiton. -![exmaple](example.png) +<img align="right" width="192" height="192" +alt="Optimizt avatar: OK sign with Mona Lisa picture between the fingers" +src="./images/logo.png"> + +There are such ways of describing the API documentation as API Blueprint, Swagger and OpenAPI. And using the tests already writed for your code, you can reuse them to find out the documentation coverage. +This makes it easy to find out how much the documentation matches the implementation. + +* Cool if you already have a project with tests and documentation, you can check how good everything is and fix microbags. + +* If are you going developing API and write documentation for it, this tool will help you document-driven development easily create high-quality write API documentation and API. + +* Also, if you have an undocumented API, this is an easy way to describe it. + +![exmaple](images/example.png) + ## Installation Add this line to your application's Gemfile: ```ruby gem 'fitting' ``` @@ -117,22 +130,33 @@ tests_without_responses: 43 ``` And task will create HTML (`fitting/index.html`) reports. -![exmaple](example.png) +![exmaple](images/example.png) More information on action coverage -![exmaple2](example2.png) +![exmaple2](images/example2.png) ## prefix name Setting the prefix name is optional. For example, you can do this: ```yaml prefixes: - openapi2_json_path: doc.json +``` + +## prefix skip + +It is not necessary to immediately describe each prefix in detail, you can only specify its name and skip it until you are ready to documented it +```yaml +prefixes: +- name: /api/v1 + openapi2_json_path: doc.json +- name: /api/v3 + skip: true ``` ## Contributing Bug reports and pull requests are welcome on GitHub at [github.com/funbox/fitting](https://github.com/funbox/fitting).