Skip to content

Commit

Permalink
README updated for the pre-alpha release.
Browse files Browse the repository at this point in the history
  • Loading branch information
keiono committed Aug 6, 2014
1 parent ff73e60 commit cfee7fa
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,23 @@

[![Build Status](https://travis-ci.org/keiono/cy-rest.svg?branch=develop)](https://travis-ci.org/keiono/cy-rest)


## Introduction
This is an App for Cytoscape 3.1+ to provide low-level access to Cytoscape data objects for R, Python, MATLAB, and other tools via RESTful API. __This app is still experimental and we need your feedback!__

### In One Sentence
__Control [Cytoscape](http://www.cytoscape.org) from [RStudio](http://www.rstudio.com/), [IPython Notebook](http://ipython.org/notebook.html), or [Node.js](http://nodejs.org/)__

### More Details
This is an App for Cytoscape 3.1+ to provide low-level access to Cytoscape data objects from R, Python, MATLAB, and other tools via RESTful API. You can write your Cytoscape workflows in standard programming languages.

__This app is still experimental and we need your feedback!__


## System Requirments
* [Java 7](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
* __Not tested on Java 8 yet!__
* Oracle JDK recommended, but should be compatible with OpenJDK.
* [Cytoscape 3.1.1+](http://www.cytoscape.org/)
* Will be supported in Cytoscape 3.2.x, but currently tested with v3.1.1.


## Documentation
Expand All @@ -14,8 +28,9 @@ All documents are available as [Wiki](https://github.com/keiono/cy-rest/wiki).
## Problems or Feature Requests?
The API is not finalized yet. Please send your feature requests to our [mailing list](https://groups.google.com/forum/#!forum/cytoscape-discuss).


## License
* Source Code: [The MIT license](http://opensource.org/licenses/MIT)
* Documentation: [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/)

© 2014 [Cytoscape Consortium](http://www.cytoscape.org/). Developed and maintained by [Keiichiro Ono](http://keiono.github.io/) (UCSD Trey Ideker Lab).
© 2014 [Cytoscape Consortium](http://www.cytoscape.org/). Developed and maintained by [Keiichiro Ono](http://keiono.github.io/), [UCSD Trey Ideker Lab](http://idekerlab.ucsd.edu/Pages/default.aspx).

0 comments on commit cfee7fa

Please sign in to comment.