Commit 668f037f authored by Daniele Venzano's avatar Daniele Venzano

Update README

parent d1082fcc
...@@ -5,23 +5,24 @@ Zoe provides a simple way to provision data analytics applications using Docker ...@@ -5,23 +5,24 @@ Zoe provides a simple way to provision data analytics applications using Docker
Resources: Resources:
- Main website: http://zoe-analytics.eu - Main website: http://zoe-analytics.eu
- Documentation: http://docs.zoe-analytics.eu - Documentation: http://docs.zoe-analytics.eu
- How to install: http://zoe-analytics.readthedocs.org/en/latest/install.html - How to install: http://docs.zoe-analytics.eu/en/latest/install.html
- Project roadmap: https://github.com/DistributedSystemsGroup/zoe/wiki
Zoe applications can be easily created by users, we provide several examples in the `zoe-applications https://github.com/DistributedSystemsGroup/zoe-applications`_ repository to get you started. Zoe applications can be easily created by users, we provide several examples in the `zoe-applications https://github.com/DistributedSystemsGroup/zoe-applications`_ repository to get you started.
Other Zoe resources: Other Zoe resources:
- Zoe applications: https://github.com/DistributedSystemsGroup/zoe-applications - Zoe applications: https://github.com/DistributedSystemsGroup/zoe-applications
- Zoe logger: https://github.com/DistributedSystemsGroup/zoe-logger - Development and API documentation: http://docs.zoe-analytics.eu/en/latest/developer/index.html
A note on the master branch A note on releases and the master branch
--------------------------- ----------------------------------------
We are currently redesigning Zoe with a new architecture, so the master branch is unstable and changes very rapidly. The Zoe master branch is tested before being published and only commits that pass the tests are published on this repository. A description of the CI pipeline is here: http://docs.zoe-analytics.eu/en/latest/quality.html
The latest stable version is maintained under the 0.9.7-stable branch. All the documentation currently refers to this stable version, unless otherwise noted.
Official releases are tagged with their version number in the repository and changes for each released version are summarised in the `ChangeLog https://github.com/DistributedSystemsGroup/zoe/blob/master/CHANGELOG.md`_ file.
Repository contents Repository contents
------------------- -------------------
...@@ -34,11 +35,9 @@ Repository contents ...@@ -34,11 +35,9 @@ Repository contents
- `zoe_master`: The core of Zoe, the server process that listens for client requests and creates the containers on Swarm - `zoe_master`: The core of Zoe, the server process that listens for client requests and creates the containers on Swarm
- `zoe_api`: The web client interface - `zoe_api`: The web client interface
|Travis build| |Documentation Status| |Documentation Status|
Zoe is licensed under the terms of the Apache 2.0 license. Zoe is licensed under the terms of the Apache 2.0 license.
.. |Documentation Status| image:: https://readthedocs.org/projects/zoe-analytics/badge/?version=latest .. |Documentation Status| image:: https://readthedocs.org/projects/zoe-analytics/badge/?version=latest
:target: https://readthedocs.org/projects/zoe-analytics/?badge=latest :target: https://readthedocs.org/projects/zoe-analytics/?badge=latest
.. |Travis build| image:: https://travis-ci.org/DistributedSystemsGroup/zoe.svg
:target: https://travis-ci.org/DistributedSystemsGroup/zoe
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment