[GitHub] glynnbird opened a new pull request #46: capitalised sentences, acronymns and added a note about Promises

[gi...@git.apache.org]

glynnbird opened a new pull request #46: capitalised sentences, acronymns and added a note about Promises
URL: https://github.com/apache/couchdb-nano/pull/46
 
 
   ## Overview
   
   The README was entirely in lowercase. While this was cute, it made it pretty unreadable as a document. I have reworked it so that
   
   - the first letter of each sentence is a captial
   - acronyms are in capitals e.g. HTTP
   - CouchDB is capitalised correctly
   
   There are a couple of other minor fixes to make the code style in the examples more consistent and add some extra examples.
   
   I've also added a paragraph on how to make the library work with Promises.
   
   ## Testing recommendations
   
   No code has changed. Just the readme.
   
   ## GitHub issue number
   
   n/a
   
   ## Related Pull Requests
   
   n/a
   
   ## Checklist
   
   - [x] Code is written and works correctly;
   - [x] Changes are covered by tests;
   - [x] Documentation reflects the changes;
   
 
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services