imbo / behat-api-extension

API extension for Behat, used to ease testing of JSON-based APIs
MIT License
109 stars 42 forks source link

Improve documentation #36

Closed christeredvartsen closed 7 years ago

christeredvartsen commented 7 years ago

Currently all documentation exists in README.md. While this might work OK for now, as more and more steps are added it gets cumbersome to update the docs, and it will become less readable by the end-user. A TL;DR with a list of the available steps should exist in the README, while end-user docs should probably be moved to Read the docs or some similar service.

christeredvartsen commented 7 years ago

Marking this as closed as docs have been fixed in the 2.0 branch.