Skip to content

Commit

Permalink
docs(readme): updating readme to clarify version
Browse files Browse the repository at this point in the history
Currently, the master version of the readme is set for the unstable 4.0.0 version
of the bson parser. This change adds a note clarifying this, and pointing to the
3.0.2 version of the README.

Fixes #278
  • Loading branch information
daprahamian authored Oct 26, 2018
1 parent d226546 commit 4ba5226
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# BSON parser

**NOTE: This is usage documentation for the current 4.0.0 beta. You can find documentation for the 3.0 version of js-bson [here](https://github.com/mongodb/js-bson/blob/v3.0.2/README.md)**

BSON is short for Bin­ary JSON and is the bin­ary-en­coded seri­al­iz­a­tion of JSON-like doc­u­ments. You can learn more about it in [the specification](http://bsonspec.org).

This browser version of the BSON parser is compiled using [rollup](https://rollupjs.org/) and the current version is pre-compiled in the `dist` directory.
Expand Down

0 comments on commit 4ba5226

Please sign in to comment.