README

# libbson

libbson is a library providing useful routines related to building, parsing,
and iterating BSON documents.  It is a useful base for those wanting to write
high-performance C extensions to higher level languages such as python, ruby,
or perl.


# Building

## From Git

```sh
$ sudo yum install automake autoconf libtool make gcc
$ ./autogen.sh --enable-silent-rules
$ make
$ sudo make install
```

You can run the unit tests with

```sh
$ make test
```

## From Tarball

```sh
$ ./configure --enable-silent-rules
$ make
$ sudo make install
```


# Developing using libbson

In your source code:

```c
#include <bson.h>
```

To get the include path and libraries appropriate for your system.

```sh
gcc my_program.c $(pkg-config --cflags --libs libbson-1.0)
```

# Examples

See the `examples/` directory for how to use the libbson library in your
application.

# Documentation

See the `doc/` directory for documentation on individual types.