Skip to content

capitalised sentences, acronymns and added a note about Promises#46

Merged
glynnbird merged 2 commits intoapache:masterfrom
glynnbird:readme
May 31, 2017
Merged

capitalised sentences, acronymns and added a note about Promises#46
glynnbird merged 2 commits intoapache:masterfrom
glynnbird:readme

Conversation

@glynnbird
Copy link
Contributor

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

  • Code is written and works correctly;
  • Changes are covered by tests;
  • Documentation reflects the changes;

Copy link
Member

@garrensmith garrensmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small minor tweak. I'll let you merge this yourself when you are ready :)

README.md Outdated

bulk operations(update/delete/insert) on the database, refer to the
[couchdb doc](http://wiki.apache.org/couchdb/HTTP_Bulk_Document_API).
Nulk operations(update/delete/insert) on the database, refer to the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you meant 'Bulk'

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed. But can't merge myself as I don't have write access

@glynnbird
Copy link
Contributor Author

@garrensmith I don't have write access to be able to merge

@glynnbird glynnbird merged commit 11744f2 into apache:master May 31, 2017
@glynnbird glynnbird deleted the readme branch May 31, 2017 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants