[44/50] [abbrv] incubator-taverna-databundle-viewer git commit: Update README: documentation, installation, usage, etc

[al...@apache.org]

Update README: documentation, installation, usage, etc


Project: http://git-wip-us.apache.org/repos/asf/incubator-taverna-databundle-viewer/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-taverna-databundle-viewer/commit/30d47c03
Tree: http://git-wip-us.apache.org/repos/asf/incubator-taverna-databundle-viewer/tree/30d47c03
Diff: http://git-wip-us.apache.org/repos/asf/incubator-taverna-databundle-viewer/diff/30d47c03

Branch: refs/heads/master
Commit: 30d47c03d9cf5011aa61564da2d6023d6510185f
Parents: 3b80868
Author: Denis Karyakin <sa...@gmail.com>
Authored: Wed Aug 19 23:19:48 2015 +0300
Committer: Denis Karyakin <sa...@gmail.com>
Committed: Wed Aug 19 23:19:48 2015 +0300

----------------------------------------------------------------------
 README.md | 48 +++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 43 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-taverna-databundle-viewer/blob/30d47c03/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 0dc000a..7556158 100644
--- a/README.md
+++ b/README.md
@@ -122,14 +122,52 @@ Don't forget: Keeping Environment Variables Private
 
 # Usage
 
-Run server with command `rails s`
+**In development environment**
 
-_TODO_
+1. Run server with command `rails s`
+2. Open in the browser a address `http://localhost:3000`
 
-* ...
+**In production environment**
+
+1. Run `rake assets:precompile`
+2. Run server with command `RAILS_ENV=production rails s`
+3. Open in the browser a address `http://localhost:3000`
+
+Also you can deploy this application to [Heroku](http://heroku.com/)
+
+For upload new databundle file, you need to be logged in.
+You may log in with your facebook or google account, or register in DataBundle viewer site.
+
+When you logged in, you can upload databundle file in box 'New Databundle'. Enter name for the databundle and choose file to upload.
+
+After click on 'Save' you will see information about workflow run:
+
+1. Workflow name
+2. Authors of the workflow
+3. Titles
+4. Description
+
+And also you will see dataflow diagram of workflow run. You can click on edges of the graph to see what value produced by this step
 
 # Documentation
 
-_TODO_
+Dependencies listed in [Gemfile](Gemfile) (gems) and in [bower.json](bower.json) (front-end assets)
+
+Licenses to every dependency presented in [DEPENDENCY_LICENSES.md](DEPENDENCY_LICENSES.md) file
+
+Main classes of the application:
+
+1. [DataBundleDecorator](app/decorators/data_bundle_decorator.rb): access to data_bundle file as ro_bundle.
+Methods for get inputs/outputs/intermediates values
+
+2. [DataBundle](app/models/data_bundle.rb): necessary constants, and logic by extract data_bundle file after upload
+
+Visualization component in [data_bundle.coffee](app/assets/javascripts/data_bundle.coffee)
+
+# Todo
+
+1. Better visualization
+
+2. Show intermediates run results with taverna-prov
 
-* ...
+3. Docker image with auto install dependencies and run server