Skip to content

Commit e1e9890

Browse files
committed
Updating README
1 parent c9ecb41 commit e1e9890

File tree

1 file changed

+5
-62
lines changed

1 file changed

+5
-62
lines changed

README.md

Lines changed: 5 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -4,70 +4,13 @@ The officially supported Ruby driver for [MongoDB](http://www.mongodb.org).
44

55
> **Note: You are viewing the 2.x version of the MongoDB Ruby driver which is currently unreleased and under heavy development. To view the current stable version of driver, please use the [1.x-stable](https://github.com/mongodb/mongo-ruby-driver/tree/1.x-stable) branch.**
66
7-
8-
Installation
9-
-----
10-
11-
**Gem Installation**<br>
12-
The Ruby driver is released and distributed through RubyGems and it can be installed with the following command:
13-
```bash
14-
gem install mongo
15-
```
16-
**Github Installation**<br>
17-
For development and test environments (not recommended for production) you can also install the Ruby driver directly from source:
18-
19-
```bash
20-
# clone the repository
21-
git clone https://github.com/mongodb/mongo-ruby-driver.git
22-
cd mongo-ruby-driver
23-
24-
# checkout a specific version by tag (optional)
25-
git checkout 2.x.x
26-
27-
# install all development dependencies
28-
gem install bundler
29-
bundle install
30-
31-
# install the ruby driver
32-
rake install
33-
```
34-
35-
Usage
7+
Documentation
368
-----
37-
Here is a quick example of basic usage for the Ruby driver:
38-
```ruby
39-
require 'mongo'
409

41-
# connecting to the database
42-
client = Mongo::Client.new # defaults to localhost:27017
43-
db = client['example-db']
44-
coll = db['example-collection']
45-
46-
# inserting documents
47-
10.times { |i| coll.insert({ :count => i+1 }) }
48-
49-
# finding documents
50-
puts "There are #{coll.count} total documents. Here they are:"
51-
coll.find.each { |doc| puts doc.inspect }
52-
53-
# updating documents
54-
coll.update({ :count => 5 }, { :count => 'foobar' })
55-
56-
# removing documents
57-
coll.remove({ :count => 8 })
58-
coll.remove
59-
```
60-
61-
For many more usage examples and a full tutorial, please visit our [wiki](https://github.com/mongodb/mongo-ruby-driver/wiki).<br>
62-
For API reference documentation, please visit [here](http://api.mongodb.org/ruby/current).
63-
64-
Compatibility
65-
-----
66-
The MongoDB Ruby driver requires Ruby 1.8.7 or greater and is regularly tested against the platforms and environments listed below.
10+
Documentation for the 2.x series is currently a work in progress, but that work can
11+
be sean in the meantime [here](https://github.com/durran/docs-ecosystem/blob/RUBY-684/source/tutorial/ruby-driver-tutorial.txt).
6712

68-
Ruby Platforms | Operating Systems | Architectures
69-
-------------- | ----------------- | -------------
70-
MRI 1.9.3, 2.0.0, 2.1.0<br>JRuby 1.7.x<br>Rubinius 2.x | Windows<br>Linux<br>OS X | x86<br>x64<br>ARM
13+
API docs can be found [here](http://api.mongodb.org/ruby/).
7114

7215
Support & Feedback
7316
-----
@@ -114,7 +57,7 @@ Full release notes and release history are available [here](https://github.com/m
11457
License
11558
-----
11659

117-
Copyright (C) 2009-2013 MongoDB, Inc.
60+
Copyright (C) 2009-2015 MongoDB, Inc.
11861

11962
Licensed under the Apache License, Version 2.0 (the "License");
12063
you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)