Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

docs; fix links

  • Loading branch information...
commit c65939563a950f99be7a75e2d71ab8a9c8674696 1 parent c880917
@aheckmann aheckmann authored
Showing with 17 additions and 19 deletions.
  1. +16 −18 README.md
  2. +1 −1  docs/queries.jade
View
34 README.md
@@ -25,6 +25,10 @@ Defining a model is as easy as:
var Post = mongoose.model('BlogPost', BlogPost);
+## Documentation
+
+[mongoosejs.com](http://mongoosejs.com/)
+
## Installation
The recommended way is through the excellent [NPM](http://www.npmjs.org/):
@@ -72,15 +76,15 @@ Models are defined through the `Schema` interface.
Aside from defining the structure of your documents and the types of data you're storing, a Schema handles the definition of:
* [Validators](http://mongoosejs.com/docs/validation.html) (async and sync)
-* [Defaults](http://mongoosejs.com/docs/schematypes.html)
-* [Getters](http://mongoosejs.com/docs/getters-setters.html)
-* [Setters](http://mongoosejs.com/docs/getters-setters.html)
-* [Indexes](http://mongoosejs.com/docs/indexes.html)
+* [Defaults](http://mongoosejs.com/docs/api.html#schematype_SchemaType-default)
+* [Getters](http://mongoosejs.com/docs/api.html#schematype_SchemaType-get)
+* [Setters](http://mongoosejs.com/docs/api.html#schematype_SchemaType-set)
+* [Indexes](http://mongoosejs.com/docs/guide.html#indexes)
* [Middleware](http://mongoosejs.com/docs/middleware.html)
-* [Methods](http://mongoosejs.com/docs/methods-statics.html) definition
-* [Statics](http://mongoosejs.com/docs/methods-statics.html) definition
+* [Methods](http://mongoosejs.com/docs/guide.html#methods) definition
+* [Statics](http://mongoosejs.com/docs/guide.html#statics) definition
* [Plugins](http://mongoosejs.com/docs/plugins.html)
-* [DBRefs](http://mongoosejs.com/docs/dbrefs.html)
+* [psuedo-JOINs](http://mongoosejs.com/docs/populate.html)
The following example shows some of these features:
@@ -129,7 +133,7 @@ Or we can find documents from the same collection
// docs.forEach
});
-You can also `findOne`, `findById`, `update`, etc. For more details check out [this link](http://mongoosejs.com/docs/finding-documents.html).
+You can also `findOne`, `findById`, `update`, etc. For more details check out [this link](http://mongoosejs.com/docs/queries.html).
**Important!** If you opened a separate connection using `mongoose.createConnection()` but attempt to access the model through `mongoose.model('ModelName')` it will not work as expected since it is not hooked up to an active db connection. In this case access your model through the connection you created:
@@ -296,7 +300,7 @@ You can find the [Dox](http://github.com/visionmedia/dox) generated API docs [he
## Driver access
-The driver being used defaults to [node-mongodb-native](https://github.com/christkv/node-mongodb-native) and is directly accessible through `YourModel.collection`. **Note**: using the driver directly bypasses all Mongoose power-tools like validation, getters, setters, hooks, etc.
+The driver being used defaults to [node-mongodb-native](https://github.com/mongodb/node-mongodb-native) and is directly accessible through `YourModel.collection`. **Note**: using the driver directly bypasses all Mongoose power-tools like validation, getters, setters, hooks, etc.
## Mongoose Plugins
@@ -306,21 +310,15 @@ Take a peek at the [plugins search site](http://plugins.mongoosejs.com/) to see
### Cloning the repository
-Make a fork of `mongoose`, then clone it in your computer. The `v3.x` branch is for v3 development, the `v2.x` branch is for v2 development, and the `master` branch the next upcoming major release.
+ git clone git://github.com/LearnBoost/mongoose.git
### Guidelines
-- Before starting to write code, look for existing [tickets](https://github.com/learnboost/mongoose/issues) or [create one](https://github.com/learnboost/mongoose/issues/new) for your specific issue. That way you avoid working on something that might not be of interest or that has been addressed already in a different branch.
-- Write inline documentation for new methods or class members.
-- Write tests and make sure they pass.
-- Follow the general coding style of the rest of the project (comma first, etc).
+See [contributing](http://mongoosejs.com/docs/contributing.html).
## Credits
-- Guillermo Rauch - guillermo@learnboost.com - [Guille](http://github.com/guille)
-- Nathan White - [nw](http://github.com/nw/)
-- Brian Noguchi - [bnoguchi](https://github.com/bnoguchi)
-- Aaron Heckmann - [aheckmann](https://github.com/aheckmann)
+[contributors](https://github.com/learnboost/mongoose/graphs/contributors)
## License
View
2  docs/queries.jade
@@ -55,5 +55,5 @@ block content
h3 Streaming
:markdown
- Queries can be [streamed](http://nodejs.org/api/stream.html) from MongoDB to your application as well. Simply call the query's [stream](./api.html#query_Query-stream) method instead of [exec](./api.html#query_Query-exec) to return an instance of [QueryStream](./api.html#query_Query-stream).
+ Queries can be [streamed](http://nodejs.org/api/stream.html) from MongoDB to your application as well. Simply call the query's [stream](./api.html#query_Query-stream) method instead of [exec](./api.html#query_Query-exec) to return an instance of [QueryStream](./api.html#querystream_QueryStream).

0 comments on commit c659395

Please sign in to comment.
Something went wrong with that request. Please try again.