Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

docs; fix links

  • Loading branch information...
commit c65939563a950f99be7a75e2d71ab8a9c8674696 1 parent c880917
Aaron Heckmann aheckmann authored

Showing 2 changed files with 17 additions and 19 deletions. Show diff stats Hide diff stats

  1. +16 18 README.md
  2. +1 1  docs/queries.jade
34 README.md
Source Rendered
@@ -25,6 +25,10 @@ Defining a model is as easy as:
25 25
26 26 var Post = mongoose.model('BlogPost', BlogPost);
27 27
  28 +## Documentation
  29 +
  30 +[mongoosejs.com](http://mongoosejs.com/)
  31 +
28 32 ## Installation
29 33
30 34 The recommended way is through the excellent [NPM](http://www.npmjs.org/):
@@ -72,15 +76,15 @@ Models are defined through the `Schema` interface.
72 76 Aside from defining the structure of your documents and the types of data you're storing, a Schema handles the definition of:
73 77
74 78 * [Validators](http://mongoosejs.com/docs/validation.html) (async and sync)
75   -* [Defaults](http://mongoosejs.com/docs/schematypes.html)
76   -* [Getters](http://mongoosejs.com/docs/getters-setters.html)
77   -* [Setters](http://mongoosejs.com/docs/getters-setters.html)
78   -* [Indexes](http://mongoosejs.com/docs/indexes.html)
  79 +* [Defaults](http://mongoosejs.com/docs/api.html#schematype_SchemaType-default)
  80 +* [Getters](http://mongoosejs.com/docs/api.html#schematype_SchemaType-get)
  81 +* [Setters](http://mongoosejs.com/docs/api.html#schematype_SchemaType-set)
  82 +* [Indexes](http://mongoosejs.com/docs/guide.html#indexes)
79 83 * [Middleware](http://mongoosejs.com/docs/middleware.html)
80   -* [Methods](http://mongoosejs.com/docs/methods-statics.html) definition
81   -* [Statics](http://mongoosejs.com/docs/methods-statics.html) definition
  84 +* [Methods](http://mongoosejs.com/docs/guide.html#methods) definition
  85 +* [Statics](http://mongoosejs.com/docs/guide.html#statics) definition
82 86 * [Plugins](http://mongoosejs.com/docs/plugins.html)
83   -* [DBRefs](http://mongoosejs.com/docs/dbrefs.html)
  87 +* [psuedo-JOINs](http://mongoosejs.com/docs/populate.html)
84 88
85 89 The following example shows some of these features:
86 90
@@ -129,7 +133,7 @@ Or we can find documents from the same collection
129 133 // docs.forEach
130 134 });
131 135
132   -You can also `findOne`, `findById`, `update`, etc. For more details check out [this link](http://mongoosejs.com/docs/finding-documents.html).
  136 +You can also `findOne`, `findById`, `update`, etc. For more details check out [this link](http://mongoosejs.com/docs/queries.html).
133 137
134 138 **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:
135 139
@@ -296,7 +300,7 @@ You can find the [Dox](http://github.com/visionmedia/dox) generated API docs [he
296 300
297 301 ## Driver access
298 302
299   -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.
  303 +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.
300 304
301 305 ## Mongoose Plugins
302 306
@@ -306,21 +310,15 @@ Take a peek at the [plugins search site](http://plugins.mongoosejs.com/) to see
306 310
307 311 ### Cloning the repository
308 312
309   -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.
  313 + git clone git://github.com/LearnBoost/mongoose.git
310 314
311 315 ### Guidelines
312 316
313   -- 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.
314   -- Write inline documentation for new methods or class members.
315   -- Write tests and make sure they pass.
316   -- Follow the general coding style of the rest of the project (comma first, etc).
  317 +See [contributing](http://mongoosejs.com/docs/contributing.html).
317 318
318 319 ## Credits
319 320
320   -- Guillermo Rauch - guillermo@learnboost.com - [Guille](http://github.com/guille)
321   -- Nathan White - [nw](http://github.com/nw/)
322   -- Brian Noguchi - [bnoguchi](https://github.com/bnoguchi)
323   -- Aaron Heckmann - [aheckmann](https://github.com/aheckmann)
  321 +[contributors](https://github.com/learnboost/mongoose/graphs/contributors)
324 322
325 323 ## License
326 324
2  docs/queries.jade
@@ -55,5 +55,5 @@ block content
55 55
56 56 h3 Streaming
57 57 :markdown
58   - 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).
  58 + 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).
59 59

0 comments on commit c659395

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