ansasaki / abimap

A helper for library maintainers to use symbol versioning
MIT License
7 stars 1 forks source link

documentation misses a quick start #58

Closed nmav closed 6 years ago

nmav commented 6 years ago

The documentation in README.md is very good, and describes (and sells well) the reason for this tool. However, when reading it, I found it stopping in a quite abrupt way and referring to documentation. I think the README could benefit by having the tl;dr section of the documentation in addition to referencing there.