You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+51-18Lines changed: 51 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,9 @@ has a link to API Documentation for the current release.
18
18
19
19
If you have the source, you can generate the matching documentation by typing
20
20
21
-
$ rake docs
21
+
```sh
22
+
$ rake docs
23
+
```
22
24
23
25
Once generated, the API documentation can be found in the docs/ folder.
24
26
@@ -73,16 +75,22 @@ Note that if you're on 1.8.7, be sure that you're using a patchlevel >= 249. The
73
75
74
76
### Gems
75
77
76
-
$ gem update --system
77
-
$ gem install mongo
78
+
```sh
79
+
$ gem update --system
80
+
$ gem install mongo
81
+
```
78
82
79
83
For a significant performance boost, you'll want to install the C extension:
80
84
81
-
$ gem install bson_ext
85
+
```sh
86
+
$ gem install bson_ext
87
+
```
82
88
83
89
Note that bson_ext isn't used with JRuby. Instead, we use some native Java extensions are bundled with the bson gem. If you ever need to modify these extensions, you can recompile with the following rake task:
84
90
85
-
$ rake compile:jbson
91
+
```sh
92
+
$ rake compile:jbson
93
+
```
86
94
87
95
### From the GitHub source
88
96
@@ -91,7 +99,9 @@ You can either clone the git repository or download a tarball or zip file.
91
99
Once you have the source, you can use it from wherever you downloaded it or
92
100
you can install it as a gem from the source by typing:
93
101
94
-
$ rake install
102
+
```sh
103
+
$ rake install
104
+
```
95
105
96
106
# Examples
97
107
@@ -140,7 +150,7 @@ timeout for waiting for old connections to be released to the pool.
140
150
To set up a pooled connection to a single MongoDB instance:
0 commit comments