Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Update for new repository VoliJS #59

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@
<div id="toc">
</div>
<ul class="toc-footer">
<li><a href="https://github.com/Volicon/Type-R">GitHub repository</a></li>
<li><a href="https://github.com/Volicon/Type-R/issues">Report the bug</a></li>
<li><a href="https://github.com/VoliJS/Type-R">GitHub repository</a></li>
<li><a href="https://github.com/VoliJS/Type-R/issues">Report the bug</a></li>
<li><a href="https://groups.google.com/forum/#!forum/volicon-open-source">Ask the question</a></li>
<li><a href="http://www.volicon.com/">Supported by <img style="vertical-align: middle" src="images/volicon_verizon_dm.png"/></a></li>
</ul>
Expand Down Expand Up @@ -296,12 +296,12 @@ <h2 id="installation-and-requirements">Installation and requirements</h2>
<aside class="warning">IE9 and Opera may work but has not been tested. IE8 won't work.</aside>

<h2 id="reactjs-bindings">ReactJS bindings</h2>
<p><a href="https://volicon.github.io/React-MVx/">React-MVx</a> is a glue framework which uses Type-R to manage the UI state in React and the <a href="https://github.com/Volicon/NestedLink">NestedLink</a> library to implement two-way data binding. React-MVx provides the complete MVVM solution on top of ReactJS, featuring:</p>
<p><a href="https://github.com/VoliJS/React-Type-R">React-MVx</a> is a glue framework which uses Type-R to manage the UI state in React and the <a href="https://github.com/VoliJS/NestedLink">NestedLink</a> library to implement two-way data binding. React-MVx provides the complete MVVM solution on top of ReactJS, featuring:</p>
<ul>
<li>Type-R <a href="https://volicon.github.io/Type-R/#record">Record</a> to manage the local <a href="https://volicon.github.io/React-MVx/#state">component&#39;s state</a>.</li>
<li><a href="https://volicon.github.io/React-MVx/#link">two-way data binding</a> for UI and domain state.</li>
<li>Type-R <a href="https://volijs.github.io/Type-R/#definition">Record</a> to manage the local <a href="https://volijs.github.io/React-Type-R/#state">component&#39;s state</a>.</li>
<li><a href="https://volijs.github.io/React-Type-R/#link">two-way data binding</a> for UI and domain state.</li>
<li>Hassle-free form validation (due to the combination of features of Type-R and NestedLink).</li>
<li><a href="https://volicon.github.io/Type-R/#definition">Type-R type annotation</a> used to define component <a href="https://volicon.github.io/React-MVx/#props">props</a> and <a href="https://volicon.github.io/React-MVx/#context">context</a>.</li>
<li><a href="https://volijs.github.io/Type-R/#definition">Type-R type annotation</a> used to define component <a href="https://volijs.github.io/React-Type-R/#props">props</a> and <a href="https://volicon.github.io/React-MVx/#context">context</a>.</li>
</ul>
<h2 id="usage-with-nodejs">Usage with NodeJS</h2>
<p>Type-R can be used at the server side to build the business logic layer by defining the custom I/O endpoints to store data in a database. Type-R dynamic type safety features are particularly advantageous when schema-less JSON databases (like Couchbase) are being used.</p>
Expand Down Expand Up @@ -2254,8 +2254,8 @@ <h2 id="2-1-0">2.1.0</h2>
<p>This release adds long-awaited HTTP REST endpoint.</p>
<ul>
<li>IO endpoints moved outside of the man sources tree. Creation of the custom endpoints is easier than ever.</li>
<li>Added HTTP REST endpoint <code>restfulIO</code> with relative urls support (<a href="https://volicon.github.io/Type-R/#endpoint-restfulio-url-options-)">https://volicon.github.io/Type-R/#endpoint-restfulio-url-options-)</a>.</li>
<li>Added proxyIO endpoint for creating endpoints from records on the server side (<a href="https://volicon.github.io/Type-R/#endpoint-proxyio-recordctor-)">https://volicon.github.io/Type-R/#endpoint-proxyio-recordctor-)</a>.</li>
<li>Added HTTP REST endpoint <code>restfulIO</code> with relative urls support (<a href="https://volijs.github.io/Type-R/#endpoint-restfulio-url-options-)">https://volijs.github.io/Type-R/#endpoint-restfulio-url-options-)</a>.</li>
<li>Added proxyIO endpoint for creating endpoints from records on the server side (<a href="https://volijs.github.io/Type-R/#endpoint-proxyio-recordctor-)">https://volijs.github.io/Type-R/#endpoint-proxyio-recordctor-)</a>.</li>
</ul>
<h2 id="2-0-0">2.0.0</h2>
<p>This release brings new features which fixes problems with component&#39;s inheritance in React bindings and implements long-awaited generic IO implementation based on ES6 promises.</p>
Expand Down
12 changes: 6 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ language_tabs:
logoTitle: Type-R 3.0

toc_footers:
- <a href="https://github.com/Volicon/Type-R">GitHub repository</a>
- <a href="https://github.com/Volicon/Type-R/issues">Report the bug</a>
- <a href="https://github.com/Volijs/Type-R">GitHub repository</a>
- <a href="https://github.com/Volijs/Type-R/issues">Report the bug</a>
- <a href="https://groups.google.com/forum/#!forum/volicon-open-source">Ask the question</a>
- <a href="http://www.volicon.com/">Supported by <img style="vertical-align: middle" src="images/volicon_verizon_dm.png"/></a>

Expand Down Expand Up @@ -233,12 +233,12 @@ Is packed as UMD and ES6 module. No peer dependencies are required.

## ReactJS bindings

[React-MVx](https://volicon.github.io/React-MVx/) is a glue framework which uses Type-R to manage the UI state in React and the [NestedLink](https://github.com/Volicon/NestedLink) library to implement two-way data binding. React-MVx provides the complete MVVM solution on top of ReactJS, featuring:
[React-MVx](https://github.com/VoliJS/React-Type-R) is a glue framework which uses Type-R to manage the UI state in React and the [NestedLink](https://github.com/VoliJS/NestedLink) library to implement two-way data binding. React-MVx provides the complete MVVM solution on top of ReactJS, featuring:

- Type-R [Record](https://volicon.github.io/Type-R/#record) to manage the local [component's state](https://volicon.github.io/React-MVx/#state).
- [two-way data binding](https://volicon.github.io/React-MVx/#link) for UI and domain state.
- Type-R [Record](https://volijs.github.io/Type-R/#record) to manage the local [component's state](https://volijs.github.io/React-Type-R/#state).
- [two-way data binding](https://volijs.github.io/React-Type-R/#link) for UI and domain state.
- Hassle-free form validation (due to the combination of features of Type-R and NestedLink).
- [Type-R type annotation](https://volicon.github.io/Type-R/#definition) used to define component [props](https://volicon.github.io/React-MVx/#props) and [context](https://volicon.github.io/React-MVx/#context).
- [Type-R type annotation](https://volijs.github.io/Type-R/#definition) used to define component [props](https://volijs.github.io/React-Type-R/#props) and [context](https://volijs.github.io/React-Type-R/#context).

## Usage with NodeJS

Expand Down