Skip to content

Commit 44fd219

Browse files
committed
Word-capitalize all headings
1 parent dc993e5 commit 44fd219

File tree

1 file changed

+16
-20
lines changed

1 file changed

+16
-20
lines changed

README.md

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# An alternative Mongodb driver for Elixir
1+
# An Alternative MongoDB Driver for Elixir
22
[![Build Status](https://travis-ci.org/zookzook/elixir-mongodb-driver.svg?branch=master)](https://travis-ci.org/zookzook/elixir-mongodb-driver)
33
[![Coverage Status](https://coveralls.io/repos/github/zookzook/elixir-mongodb-driver/badge.svg?branch=master)](https://coveralls.io/github/zookzook/elixir-mongodb-driver?branch=master)
44
[![Hex.pm](https://img.shields.io/hexpm/v/mongodb_driver.svg)](https://hex.pm/packages/mongodb_driver)
@@ -24,7 +24,7 @@
2424
* support for retryable reads ([See](https://github.com/mongodb/specifications/blob/master/source/retryable-reads/retryable-reads.rst))
2525
* support for retryable writes ([See](https://github.com/mongodb/specifications/blob/master/source/retryable-writes/retryable-writes.rst))
2626

27-
## Data representation
27+
## Data Representation
2828

2929
BSON Elixir
3030
---------- ------
@@ -50,7 +50,7 @@ BSON symbols can only be decoded.
5050

5151
## Usage
5252

53-
### Installation:
53+
### Installation
5454

5555
Add `mongodb_driver` to your mix.exs `deps`.
5656

@@ -62,7 +62,7 @@ end
6262

6363
Then run `mix deps.get` to fetch dependencies.
6464

65-
### Simple connection to MongoDB
65+
### Simple Connection to MongoDB
6666

6767
```elixir
6868
# Starts an unpooled connection
@@ -112,7 +112,7 @@ Failing operations return a `{:error, error}` tuple where `error` is a
112112
}}
113113
```
114114

115-
### Connection pooling
115+
### Connection Pooling
116116
The driver supports pooling by DBConnection (2.x). By default `mongodb_driver` will start a single
117117
connection, but it also supports pooling with the `:pool_size` option. For 3 connections add the `pool_size: 3` option to `Mongo.start_link` and to all
118118
function calls in `Mongo` using the pool:
@@ -158,7 +158,7 @@ of a `:hostname` and `:port` pair.
158158
This will allow for scenarios where the first `"hostname1.net:27017"` is unreachable for any reason
159159
and will automatically try to connect to each of the following entries in the list to connect to the cluster.
160160

161-
### Auth mechanisms
161+
### Auth Mechanisms
162162

163163
For versions of Mongo 3.0 and greater, the auth mechanism defaults to SCRAM.
164164
If you'd like to use [MONGODB-X509](https://docs.mongodb.com/manual/tutorial/configure-x509-client-authentication/#authenticate-with-a-x-509-certificate)
@@ -168,7 +168,7 @@ authentication, you can specify that as a `start_link` option.
168168
{:ok, pid} = Mongo.start_link(database: "test", auth_mechanism: :x509)
169169
```
170170

171-
### AWS, TLS and Erlang SSL ciphers
171+
### AWS, TLS and Erlang SSL Ciphers
172172

173173
Some MongoDB cloud providers (notably AWS) require a particular TLS cipher that isn't enabled
174174
by default in the Erlang SSL module. In order to connect to these services,
@@ -204,7 +204,7 @@ Using `$in`
204204
Mongo.find(:mongo, "users", %{email: %{"$in" => ["[email protected]", "[email protected]"]}})
205205
```
206206

207-
### Change streams
207+
### Change Streams
208208

209209
Change streams are available in replica set and sharded cluster deployments
210210
and tell you about changes to documents in collections. They work like endless
@@ -256,7 +256,7 @@ Mongo.insert_many(top, "users", [
256256
])
257257
```
258258

259-
### Bulk writes
259+
### Bulk Writes
260260

261261
The motivation for bulk writes lies in the possibility of optimization, the same operations
262262
to group. Here, a distinction is made between disordered and ordered bulk writes.
@@ -320,10 +320,8 @@ and have a look at the test units as well.
320320

321321
### GridFS
322322

323-
The driver supports the GridFS specifications. You create a `Mongo.GridFs.Bucket` struct and with this struct you can
324-
upload and download files.
325-
326-
### Example
323+
The driver supports the GridFS specifications. You create a `Mongo.GridFs.Bucket`
324+
struct and with this struct you can upload and download files. For example:
327325

328326
```elixir
329327
bucket = Bucket.new(top)
@@ -409,8 +407,6 @@ iex> Mongo.find_one(conn, "test", %{})
409407
The `travis.yml` file uses only the latest MongoDB. It creates a replica set of three nodes and disables the SSL test case. If you want to
410408
run the test cases against other MongoDB deployments or older versions, you can use the [mtools](https://github.com/rueckstiess/mtools) for deployment and run the test cases locally:
411409

412-
### Example
413-
414410
```bash
415411
pyenv global 3.6
416412
pip3 install --upgrade pip
@@ -422,11 +418,11 @@ mix test --exclude ssl --exclude socket
422418

423419
The SSL test suite is disabled by default.
424420

425-
### Enable the SSL tests
421+
### Enable the SSL Tests
426422

427423
`mix test --exclude ssl`
428424

429-
### Enable SSL on your Mongo server
425+
### Enable SSL on Your MongoDB Server
430426

431427
```bash
432428
$ openssl req -newkey rsa:2048 -new -x509 -days 365 -nodes -out mongodb-cert.crt -keyout mongodb-cert.key
@@ -437,21 +433,21 @@ $ mongod --sslMode allowSSL --sslPEMKeyFile /path/to/mongodb.pem
437433
* For `--sslMode` you can use one of `allowSSL` or `preferSSL`
438434
* You can enable any other options you want when starting `mongod`
439435

440-
## More examples
436+
## More Examples
441437

442438
There are some basic examples in the `example` folder. But if you want to see the driver in action
443439
take a look at [Vega](https://github.com/zookzook/vega), especially the [Board.ex](https://github.com/zookzook/vega/blob/master/lib/vega/board.ex) module for using the transaction api together with
444440
bulk operations.
445441

446-
## Special thanks
442+
## Special Thanks
447443

448444
Special thanks to [JetBrains](https://www.jetbrains.com/?from=elixir-mongodb-driver) for providing a free JetBrains Open Source license for their complete toolbox.
449445

450446
The [Documentation](https://hexdocs.pm/mongodb_driver/readme.html) is online, but currently not up to date.
451447
This will be done as soon as possible. In the meantime, look in the source code. Especially
452448
for the individual options.
453449

454-
This driver is based on [original](https://github.com/ankhers/mongodb).
450+
This driver is based on the [original Elixir driver for MongoDB](https://github.com/ankhers/mongodb).
455451

456452
## License
457453

0 commit comments

Comments
 (0)