rightfold / purescript-postgresql-client

https://pursuit.purescript.org/packages/purescript-postgresql-client
BSD 3-Clause "New" or "Revised" License
35 stars 20 forks source link

Split README into sections #33

Closed paluh closed 2 years ago

paluh commented 5 years ago

I think that we can split docs into three sections: Quering, Error handling, handling Custom types sections. What do you think? @akheron do you have any suggestions what kind of examples and explanations we should add to the Error handling section in README. Maybe you want to write a few words :-P

P.S. Currently README should be easily testable with just npm install and npm test (which generates test/README.purs as an side effect).

paluh commented 2 years ago

Closing this as there is more general issue around docs.