diff --git a/LICENSE.md b/LICENSE.txt similarity index 100% rename from LICENSE.md rename to LICENSE.txt diff --git a/README.md b/README.md new file mode 100755 index 00000000..52560fd3 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Recline + +A pure javascript data explorer and data refinery. Imagine it as a spreadsheet plus Google Refine plus Visualization toolkit, all in pure javascript and html. + +Designed for standalone use or as a library to integrate into your own app. + +## Features + +* CSV/JSON export your entire database for integration with spreadsheets or + [Google Refine](http://code.google.com/p/google-refine/) +* Bulk update/clean your data using an easy scripting UI +* Import by directly downloading from JSON APIs or by uploading files + +![screenshot](http://i.imgur.com/XDSRe.png) + +## Demo App + +Open demo/index.html in your favourite browser. + diff --git a/readme.md b/readme.md deleted file mode 100755 index 97aac89a..00000000 --- a/readme.md +++ /dev/null @@ -1,31 +0,0 @@ -# Recline - -A HTML5 port of Google Refine's UI that lets you bulk import, edit and export your data in and out of CouchDB - -## Features - -* CSV/JSON export your entire database for integration with spreadsheets or [Google Refine](http://code.google.com/p/google-refine/) -* Bulk update/clean your data using an easy scripting UI -* Import by directly downloading from JSON APIs or by uploading files - -![screenshot](http://i.imgur.com/XDSRe.png) - -## Installation - -After you install it, visit this link to open Recline: - - http://yourcouch/yourdb/_design/recline/_rewrite - -### Quick install - -[Get a couch](http://www.iriscouch.com/service), make a database and put some data into it. - -Copy these utilities to the new db: - - curl -X POST http://user:pass@YOURCOUCH/_replicate -d '{"source":"http://max.iriscouch.com/apps","target":"YOURDB", "doc_ids":["_design/recline"]}' -H "Content-type: application/json" - -### In-depth install - -You'll have to get yourself a couch. The easiest way is from [the instructions on this page](http://iriscouch.com/service). Once it's going, open up `http://YOURCOUCH/_utils` and create a new database to store your data. - -You can either replicate the couchapp from my couch [max.iriscouch.com/apps/_design/recline](http://max.iriscouch.com/apps/_design/recline) (quickest option) or, if you want to hack on the recline source code first, you'll need to install `mikeal/node.couchapp.js` and clone this repo. \ No newline at end of file