Skip to content

Commit 4ba5226

Browse files
authored
docs(readme): updating readme to clarify version
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
1 parent d226546 commit 4ba5226

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# BSON parser
22

3+
**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)**
4+
35
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).
46

57
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.

0 commit comments

Comments
 (0)