search

nulpunkt / yesql-php

A clone of the wonderful yesql clojure library, for php
23 stars 7 forks source link

Add titles to the examples in the README #6

Closed terales closed 6 years ago

terales commented 6 years ago

As @nulpunkt asked in https://github.com/nulpunkt/yesql-php/issues/5#issuecomment-366642404:

The readme is getting longer, so it would be cool with ideas on how to improve it!

I don't mind long README, but I see it as a very useful feature. With long README you can search on the page with a browser and without any code. Consider example: https://github.com/avajs/ava

The only thing we need to have a useful long README is to add the Contents section. To make it more readable we need to add titles to the examples.

nulpunkt commented 6 years ago

This is a great idea for improving the README!

nulpunkt commented 6 years ago

Just added titles, let me know if they suck too much :)

terales commented 6 years ago

They are awesome! Thanks a lot!

nulpunkt commented 6 years ago

Thanks! :smile: