search

apiaryio / gavel.js

Validator of HTTP messages (JavaScript implementation)
MIT License
97 stars 22 forks source link

README is outdated #65

Closed honzajavorek closed 8 years ago

honzajavorek commented 8 years ago

It contains links to non-existing docs etc. It should undergo some facelift. Issues reported by @XVincentX.

XVincentX commented 8 years ago

A good starting point would be to move relishapp content into the readme.

honzajavorek commented 8 years ago

@XVincentX I made some changes in how the docs are handled, but due to the nature of its contents, most of the valuable information will be on Relish now.

At the same time, I'd like to replace Relish with something else in the future - https://github.com/apiaryio/gavel-spec/issues/21. Once #74 gets merged, I'd like to hear your feedback on whether the docs improved at least a bit and are more understandable.