Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updating the documentation to provide clarity and pronoun tense agree…

…ment
  • Loading branch information...
commit 370b204c23619c76a2a127e2e8702b6199ee03a0 1 parent 81784d4
@yawetse yawetse authored
Showing with 16 additions and 16 deletions.
  1. +16 −16 docs/jugglingdb.md
View
32 docs/jugglingdb.md
@@ -1,39 +1,39 @@
-JugglingDB(3) - cross-database ORM for nodejs and browser
+JugglingDB(3) - cross-database ORM for nodejs and the browser
=========================================================
## DESCRIPTION
-JugglingDB is a cross-db ORM for nodejs, providing **common interface** to access
-most popular database formats. Currently supported db formats are: mysql, sqlite3,
+JugglingDB is a cross-db ORM for nodejs, that provides a **common interface** to access
+many popular database engines. JugglingDB Current supports: mysql, sqlite3,
postgres, couchdb, mongodb, redis, neo4j and in-memory-storage.
-JugglingDB also works on client-side (using WebService and Memory adapters),
-which allow to write rich client-side apps talking to server using JSON API.
+JugglingDB also works client-side (using WebService and Memory adapters),
+which allows rich client-side apps to talk to application servers using a JSON API.
## INSTALLATION
-Use npm to install core package:
+Use npm to install the core package:
npm install jugglingdb --save
-Alternatively you can install jugglingdb core from github:
+Alternatively you can install the jugglingdb core from github:
npm install 1602/jugglingdb
-Then install adapter for specific database, for example `jugglingdb-redis`:
+Then install an adapter for specific database, for example for redis `jugglingdb-redis`:
npm install jugglingdb-redis
-See [ADAPTERS][] for list of available adapters.
+See [ADAPTERS][] for a list of available adapters.
## DOCUMENTATION
Autogenerated documentation available at [jsdoc.info/1602/jugglingdb].
-Human-written manual sections are:
+Hand written manual sections are:
* jugglingdb-schema(3):
- Everything about schema, data types and model definition.
+ Everything about the schema, data types and model definition.
* jugglingdb-model(3):
Model methods, features and internals.
@@ -50,7 +50,7 @@ Human-written manual sections are:
## ADAPTERS
-All adapters available as separate packages at
+All adapters are available as separate packages at
[github.com/jugglingdb] and published in npm.
* MySQL: [github](jugglingdb-mysql) [npm](mysql-adapter-npm)
@@ -63,8 +63,8 @@ All adapters available as separate packages at
## CONTRIBUTION
-You can take part in improvement of jugglingdb codebase and documents. If you see that some improvements can be done to jugglingdb, then fork repository, make proposed changes and then create new pull request.
-Please remember that your contribution is highly supported. Be sure to follow the discussion in google group and see [github issues][issues] before you make changes. It preferable that you post new comment in google group or in github before you make changes and create pull request.
+You can take part in improving the jugglingdb codebase and documents. Please make your proposed changes by forking our documentation's repository on github, and then create a new pull request.
+Please remember that your contribution is highly encouraged. Be sure to follow the discussion in google group and see [github issues][issues] before you make changes. It's preferable that you post new comment in google group or in github before you make changes and create pull request.
## FUTURE
@@ -82,8 +82,8 @@ When you find issues, please report them:
* email:
<compoundjs@googlegroups.com>
-Provide test case for reproducing error. When reporting issue to core mention
-adapter where problem could be reproduced.
+Provide a test case for reproducing your error. When reporting issues to the core, mention which
+adapter you are using and where problem could be reproduced.
## HISTORY
Please sign in to comment.
Something went wrong with that request. Please try again.