Skip to content

Commit 40b346d

Browse files
committed
Edited README.md via GitHub
1 parent 098fa98 commit 40b346d

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

+15-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
## About
22

3-
JugglingDB -- cross-db ORM, providing **common interface** to access most popular database formats. Currently supported: mysql, mongodb, redis, neo4j and js-memory-storage (yep, self-written engine for test-usage only). You can add your favorite database adapter, checkout one of existing adapters to learn how, it's super-easy, I guarantee.
3+
JugglingDB is cross-db ORM, providing **common interface** to access most popular database formats.
4+
Currently supported are: mysql, mongodb, redis, neo4j and js-memory-storage (yep,
5+
self-written engine for test-usage only). You can add your favorite database adapter, checkout one of the
6+
existing adapters to learn how, it's super-easy, I guarantee.
47

58
## Installation
69

@@ -79,7 +82,7 @@ Read the tests for usage examples: ./test/common_test.js
7982

8083
## Your own database adapter
8184

82-
To use custom adapter, pass it package name as first argument to Schema constructor:
85+
To use custom adapter, pass it's package name as first argument to `Schema` constructor:
8386

8487
mySchema = new Schema('couch-db-adapter', {host:.., port:...});
8588

@@ -89,11 +92,12 @@ Make sure, your adapter can be required (just put it into ./node_modules):
8992

9093
## Running tests
9194

92-
All tests written using nodeunit:
95+
All tests are written using nodeunit:
9396

9497
nodeunit test/common_test.js
9598

96-
If you run this line, of course it will fall, because it requres different databases to be up and running, but you can use js-memory-engine out of box! Specify ONLY env var:
99+
If you run this line, of course it will fall, because it requres different databases to be up and running,
100+
but you can use js-memory-engine out of box! Specify ONLY env var:
97101

98102
ONLY=memory nodeunit test/common_test.js
99103

@@ -103,13 +107,17 @@ of course, if you have redis running, you can run
103107

104108
## Package structure
105109

106-
Now all common logic desribed in ./index.js, and database-specific stuff in ./lib/*.js. It super-tiny, yep?
110+
Now all common logic described in ./index.js, and database-specific stuff in ./lib/*.js. It's super-tiny, right?
107111

108112
## Project status
109113

110-
This project written in one weekend (1,2 oct 2011), and of course it not pretend to be preduction-ready, but I plan to use this project as default ORM for RailwayJS in nearest future. So, if you familiar with some database engines - please help me to improve adapter for that database.
114+
This project was written in one weekend (1,2 oct 2011), and of course does not claim to be production-ready,
115+
but I plan to use this project as default ORM for RailwayJS in nearest future.
116+
So, if you are familiar with some database engines - please help me to improve adapter for that database.
111117

112-
For example, I know, mysql implementation sucks now, 'cause I'm not digging too deep into SequelizeJS code, and I think would be better to replace sequelize with something low-level in nearest future, such as `mysql` package from npm.
118+
For example, I know, mysql implementation sucks now, 'cause I'm not digging too deep into SequelizeJS code,
119+
and I think it would be better to replace sequelize with something low-level in nearest future, such
120+
as `mysql` package from npm.
113121

114122
## Contributing
115123

0 commit comments

Comments
 (0)