search

sergi / go-diff

Diff, match and patch text in Go
MIT License
1.81k stars 207 forks source link

Revamp the README #50

Closed zimmski closed 7 years ago

zimmski commented 7 years ago

The README should be more user and contributor friendly. Originally it just states that this is a port of the google-diff-match-patch code which says absolutely nothing, if you do not know that piece of code. The new README first states what the repository provides, how it can be installed, gives an example and then states how someone can contribute.

I wanted to include the output for the example, but GitHub's MarkDown does currently not allow text colors, and including an image seems unnecessary.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 98.247% when pulling 269044c3ffd3e5e6f031a3305547483d576caab6 on revamp-the-readme into c55cf50e9bdd7c29505aea7517a9374f1be9a7be on master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 98.247% when pulling b48ed326b8e2ef7df6d63a935722ca52b6dc0578 on revamp-the-readme into c55cf50e9bdd7c29505aea7517a9374f1be9a7be on master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 98.881% when pulling 00579f83a30ecf49024ac509174891ce81e82c8f on revamp-the-readme into 552b4e9bbdca9e5adafd95ee98c822fdd11b330b on master.