diff --git a/packages/mongo/README.md b/packages/mongo/README.md index e69de29bb2..c75dceaca7 100644 --- a/packages/mongo/README.md +++ b/packages/mongo/README.md @@ -0,0 +1,18 @@ +# mongo + +The `mongo` package provides several paramount pieces of functionality to work +with MongoDB in Meteor: + +- an efficient [Livequery][livequery] implementation providing real-time + updates from the database by consuming the MongoDB replication log +- a fall-back Livequery implementation for cases when the replication log is not + available, implemented by polling the database +- DDP RPC end-points for updating the data from clients connected over the wire +- Serialization and deserialization of updates to the DDP format + +To learn more about [Livequery], see the project page on +[www.meteor.com][livequery]. + +XXX: +[livequery]: https://www.meteor.com/projects/livequery +