Change documentation in README file

bats-core / bats-assert

Common assertions for Bats

Creative Commons Zero v1.0 Universal

96 stars 42 forks source link

Change documentation in README file #26

Closed Potherca closed 3 years ago

Potherca commented 5 years ago

As I felt the documentation in the readme was not as inviting to people coming to this project without previous knowledge (other than the existence of BATS), I made an attempt to improve it.

This MR makes the following changes:

Clean up some of the wording in the introduction
Add a table of content at the beginning of the document
Add an overview of all availale functions
Move the "Options" section up before the full API description
Add some link to Wikipedia pages for further information

jlisee commented 3 years ago

@martin-schulze-vireso I found this improved readme really helpful. It fixes the especially confusing links to the old outdated repos. Could it be merged in?

martin-schulze-vireso commented 3 years ago

Thanks for the ping @jlisee. I did not peek beyond core, yet.