Skip to content

Commit ad8389b

Browse files
author
Vlad Balin
committed
Updated Readme
1 parent 0be546b commit ad8389b

File tree

2 files changed

+3
-10
lines changed

2 files changed

+3
-10
lines changed

README.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Getting started
44

5-
Type-R is the modern JS data framework allowing declaratively definitions of complex domain and UI application state. The state is defined as the superposition of JS classes extending `Record` and `Collection`, and has following features:
5+
Type-R is the modern JS data framework to manage complex domain and UI application state. Features:
66

77
- _It's mapped to JSON by default_. The mapping can handle sophisticated scenarios with nested JSON and relations by id, and can be easily customized for every particular attribute or class.
88
- _All changes are observable_, happens in the scope of transactions, and there's the fine-grained change events system.
@@ -17,6 +17,7 @@ Data layer is defined as a superposition of three kinds of building blocks:
1717
- *Record* classes with typed attributes.
1818
- Ordered *collections* of records.
1919
- *Stores* are records with a set of collections in its attributes used to resolve id-references in JSON.
20+
- *IOEndpoints* is an entity encapsulating I/O transport which represent the persistent collection of records.
2021

2122
Type-R is completely unopinionated on the client-server transport protocol and the view layer technology. It's your perfect M and VM in modern MVVM or MVC architecture.
2223

@@ -57,7 +58,6 @@ msg.transaction( () => { // Prepare to make the sequence of changes on msg
5758
}); // Got single 'change!!!' message in the console.
5859
```
5960

60-
6161
## [Documentation](https://volicon.github.io/Type-R/)
6262

6363
## Installation and requirements
@@ -70,10 +70,3 @@ Is packed as UMD and ES6 module. No peer dependencies are required.
7070

7171
<aside class="warning">IE9 and Opera may work but has not been tested. IE8 won't work.</aside>
7272

73-
## Roadmap
74-
75-
- Implement I/O adapter abstraction (#12). It will bring back standard BackboneJS I/O methods, and makes it trivial to substitute the transport.
76-
- Implement TypeScript support (#11). Records will become accurately typed.
77-
- API cleanup. Remove deprecated stuff to reduce size.
78-
- Maybe, implement proper two-phase update transactions. If it won't slow down the bulk updates.
79-
- Your ideas. The most wonderful features of NestedTypes and Type-R appeared as result of user's issues.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "type-r",
3-
"version": "2.0.0-rc05",
3+
"version": "2.0.0",
44
"description": "Reactive serializable data layer for modern JS applications",
55
"main": "./dist/index.js",
66
"jsnext:main": "./lib/index.js",

0 commit comments

Comments
 (0)