Skip to content

Commit

Permalink
Added note regarding 2.0.0 upgrade
Browse files Browse the repository at this point in the history
Added a note regarding the API differences in 2.0.0.
  • Loading branch information
KrisSiegel committed May 13, 2015
1 parent 1c6df77 commit 8a57f80
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ msngr.js is a small library to manage messages between components with the goal

What does that mean, exactly? Read on. Want to just jump right in? Check out [this jsfiddle](http://jsfiddle.net/jnjaosfz/) page with msngr.js already included with a "Hello, World!" example.

### Quick note regarding upcoming 2.x release
The 2.0 branch of msngr is feature complete and includes a very different API than the current 1.x version. This was necessary to ensure consistency and an easier to use API. Additional testing, benchmarking and documentation need to be completed before 2.0 is fully ready for release at the end of May. If you'd like a preview take a look at the [2.0.0 branch](https://github.com/KrisSiegel/msngr.js/tree/2.0.0).

## Quick Start
Installation can occur via bower or npm (alternatively just download msngr.js or msngr.min.js).

Expand Down

0 comments on commit 8a57f80

Please sign in to comment.