diff --git a/README.md b/README.md index fe3e7f0b..ca14e627 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,7 @@ # Racer - -[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) - Racer is a realtime model synchronization engine for Node.js. By leveraging [ShareDB](https://github.com/share/sharedb), multiple users can interact with the same data in realtime via Operational Transformation, a sophisticated conflict resolution algorithm that works in realtime and with offline clients. ShareDB also supports PubSub across multiple servers for horizontal scaling. Clients can express data subscriptions and fetches in terms of queries and specific documents, so different clients can be subscribed to different overlapping sets of data. On top of this sophisticated backend, Racer provides a simple model and event interface for writing application logic. - [![Build Status](https://travis-ci.org/derbyjs/racer.svg?branch=master)](https://travis-ci.org/derbyjs/racer) - [![Coverage Status](https://coveralls.io/repos/github/derbyjs/racer/badge.svg?branch=master)](https://coveralls.io/github/derbyjs/racer?branch=master) - -## Disclaimer - -Racer is alpha software. If you are interested in contributing, please reach out to [Nate](https://github.com/nateps). - ## Demos There are currently two demos, which are included in the [racer-examples](https://github.com/derbyjs/racer-examples) repo. @@ -40,16 +30,9 @@ There are currently two demos, which are included in the [racer-examples](https: * **Solr queries** – (Under development) A Solr adapter will support updating Solr indices as data change and queries for realtime updated search results. -## Future features - - * **Browser local storage** – Pending changes and offline model data will also sync to HTML5 localStorage for persistent offline usage. - - * **Validation** – An implementation of shared and non-shared schema-based validation is planned. - - ## Installation -Racer requires [Node v0.10](http://nodejs.org/). You will also need to have a [MongoDB](http://docs.mongodb.org/manual/installation/) and a [Redis](http://redis.io/download) server running on your machine. The examples will connect via the default configurations. +Racer requires [Node v16](http://nodejs.org/). You will also need to have a [MongoDB](http://docs.mongodb.org/manual/installation/) and a [Redis](http://redis.io/download) server running on your machine. The examples will connect via the default configurations. ``` $ npm install racer @@ -67,10 +50,10 @@ $ npm test Racer can be used independently as shown in the examples, but Racer and Derby are designed to work especially well together. Racer can also be used along with other MVC frameworks, such as Angular. -For now, Racer is mostly documented along with Derby. See the Derby [model docs](http://derbyjs.com/docs/derby-0.6/models). +For now, Racer is mostly documented along with Derby. See the Derby [model docs](https://derbyjs.github.io/derby/models). ### MIT License -Copyright (c) 2011 by Brian Noguchi and Nate Smith +Copyright (c) 2024 by Brian Noguchi and Nate Smith Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -90,22 +73,3 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -## Contributors ✨ - -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): - - - - - - - - -

Craig Beck
⚠️ 💻
- - - - - - -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file