Skip to content

Commit c4c53a0

Browse files
committed
Remove alpha disclaimer; remove contributor info (readdress later w comprehensive list)
1 parent 026bb22 commit c4c53a0

File tree

1 file changed

+3
-39
lines changed

1 file changed

+3
-39
lines changed

README.md

+3-39
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,7 @@
11
# Racer
2-
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
3-
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
4-
<!-- ALL-CONTRIBUTORS-BADGE:END -->
52

63
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.
74

8-
[![Build Status](https://travis-ci.org/derbyjs/racer.svg?branch=master)](https://travis-ci.org/derbyjs/racer)
9-
[![Coverage Status](https://coveralls.io/repos/github/derbyjs/racer/badge.svg?branch=master)](https://coveralls.io/github/derbyjs/racer?branch=master)
10-
11-
## Disclaimer
12-
13-
Racer is alpha software. If you are interested in contributing, please reach out to [Nate](https://github.com/nateps).
14-
155
## Demos
166

177
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:
4030
* **Solr queries** &ndash; (Under development) A Solr adapter will support updating Solr indices as data change and queries for realtime updated search results.
4131

4232

43-
## Future features
44-
45-
* **Browser local storage** &ndash; Pending changes and offline model data will also sync to HTML5 localStorage for persistent offline usage.
46-
47-
* **Validation** &ndash; An implementation of shared and non-shared schema-based validation is planned.
48-
49-
5033
## Installation
5134

52-
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.
35+
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.
5336

5437
```
5538
$ npm install racer
@@ -67,10 +50,10 @@ $ npm test
6750

6851
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.
6952

70-
For now, Racer is mostly documented along with Derby. See the Derby [model docs](http://derbyjs.com/docs/derby-0.6/models).
53+
For now, Racer is mostly documented along with Derby. See the Derby [model docs](https://derbyjs.github.io/derby/models).
7154

7255
### MIT License
73-
Copyright (c) 2011 by Brian Noguchi and Nate Smith
56+
Copyright (c) 2024 by Brian Noguchi and Nate Smith
7457

7558
Permission is hereby granted, free of charge, to any person obtaining a copy
7659
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,
9073
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
9174
THE SOFTWARE.
9275

93-
## Contributors ✨
94-
95-
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
96-
97-
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
98-
<!-- prettier-ignore-start -->
99-
<!-- markdownlint-disable -->
100-
<table>
101-
<tr>
102-
<td align="center"><a href="http://craigbeck.io/"><img src="https://avatars.githubusercontent.com/u/1620605?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Craig Beck</b></sub></a><br /><a href="https://github.com/derbyjs/racer/commits?author=craigbeck" title="Tests">⚠️</a> <a href="https://github.com/derbyjs/racer/commits?author=craigbeck" title="Code">💻</a></td>
103-
</tr>
104-
</table>
105-
106-
<!-- markdownlint-restore -->
107-
<!-- prettier-ignore-end -->
108-
109-
<!-- ALL-CONTRIBUTORS-LIST:END -->
110-
111-
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

0 commit comments

Comments
 (0)