diff --git a/index.html b/index.html index f2bc0da4..47a006d4 100644 --- a/index.html +++ b/index.html @@ -58,7 +58,7 @@

Recline combines a data grid, Google Refine-style data transforms @@ -68,31 +68,81 @@

Main Features

Demo

- +

Demo »

Downloads & Dependencies (Right-click, and use 'Save As')

-

Development Version (v0.2)

+

Recline Current Version (v0.2) »

+

Dependencies

+

Javascript Libraries:

+ +

CSS: the demo utilizes bootstrap but you can integrate with your own HTML and CSS. Data Explorer specific CSS can be found here in the repo: https://github.com/okfn/recline/tree/master/css.

Using It

-

Check out the the Demo and view source. The - javascript you want for actual integration is in: app.js.

+
+// Note: you should have included the relevant JS libraries (and CSS)
+// See above for dependencies
 
-    

Docs

+// Dataset is a Backbone model +var dataset = recline.Model.Dataset({ + id: 'my-id' + backend: { + // backend ID so we can look backend up in the registry (see below) + type: 'memory' + // other backend config (e.g. API url with which to communicate) + // this will usually be backend specific + ... + } +}); +// DataExplorer is a Backbone View +var explorer = recline.View.DataExplorer({ + model: dataset, + // you can specify any element to bind to in the dom + el: $('.data-explorer-here') +}); +// Start Backbone routing (if you want routing support) +Backbone.history.start(); +
+

More details and examples: see docs below and the Demo (hit view source). The javascript you want for + actual integration is in: app.js.

+ +

Documentation

+

Recline has a simple structure layered on top of the basic Model/View + distinction inherent in Backbone. There are the following three domain objects (all Backbone Models):

+ +

There are then various Views (you can easily write your own). Each view holds a pointer to a Dataset:

+ + +

Source