Update readme

pull/11/head
Thijs Cadier 9 years ago
parent 32d807f216
commit ac9dd3a357

@ -7,18 +7,13 @@ This drivers aims to be a thin wrapper around the production-ready C driver, whi
and ergonomic Rust interface that handles all the gnarly usage details of the C driver for you. and ergonomic Rust interface that handles all the gnarly usage details of the C driver for you.
Bson encoding and decoding is handled by the [bson crate](https://github.com/zonyitoo/bson-rs), the bindings Bson encoding and decoding is handled by the [bson crate](https://github.com/zonyitoo/bson-rs), the bindings
are generated using [bindgen](https://github.com/crabtw/rust-bindgen). are based on generated bindings by [bindgen](https://github.com/crabtw/rust-bindgen).
The API is experimental, it might change at any time. The API should still be considered experimental, but I'm not expecting changes at the moment.
## Compatibility ## Compatibility
The driver currently only builds on Unix, tested on Mac Os X and Linux so far. On Mac Os X you might need to The driver currently only builds on Unix, tested on Mac Os X and Linux so far.
set this environment var for building to work (see https://github.com/crabtw/rust-bindgen#building for details):
```
export DYLD_LIBRARY_PATH=/Library/Developer/CommandLineTools/usr/lib
```
## Logging ## Logging
@ -32,4 +27,4 @@ See the tests directory for examples of how to use the driver.
## Contributing ## Contributing
Contributions are very welcome, only the parts of the C driver we need have been wrapped so far. Please write a test for any behavior you add. Contributions are very welcome, only the functionality we use has been wrapped so far. Please write a test for any behavior you add.

Loading…
Cancel
Save