README.md in nuri-0.5.1 vs README.md in nuri-0.5.2
- old
+ new
@@ -1,10 +1,11 @@
-Nuri
+[Nuri](http://herry13.github.io/nuri)
====
- author: Herry [herry13@gmail.com]
- license: BSD
+[](https://travis-ci.org/herry13/nuri)
[](https://badge.fury.io/rb/nuri)
Nuri is an automated workflow configuration tool. It allows us to define the desired state of
the managed system, and the tool will automatically generate and orchestrate the execution of the workflow
that will:
@@ -27,38 +28,68 @@
Requirements
------------
- Ruby (>= 1.9.1)
- Ruby Gems:
- - sfplanner (>= 0.1.1)
- - colorize (>= 0.5.8)
- - coderay (>= 1.0.9)
+ - sfplanner
+ - sfpagent
+ - colorize
+ - coderay
-Tested on: **Ubuntu 12.04**, **Debian Squeeze**
+Tested on Linux: **Ubuntu 12.04**, **Debian Squeeze**, and **Fedora 13**
To install
----------
- $ apt-get install git make gcc curl ruby1.9.1 ruby1.9.1-dev libz-dev libaugeas-ruby1.9.1 libxml2-dev libxslt-dev
- $ gem install sfplanner colorize coderay
- $ git clone https://github.com/herry13/nuri
+ $ apt-get install curl ruby1.9.1 ruby1.9.1-dev libz-dev libaugeas-ruby1.9.1 libxml2-dev libxslt-dev make gcc
+ $ gem install nuri
Usage
-----
Assume that the model of your system is in file "model.sfp".
- to get the current state
- $ ./bin/nuri -h -m model.sfp -s
+ $ nuri state -m model.sfp
- to generate the plan
- $ ./bin/nuri -h -m model.sfp -p
+ $ nuri plan -m model.sfp
press 'Y' and enter to execute the plan (if the plan exists).
- to execute any generated plan
- $ ./bin/nuri -h -m model.sfp -a
+ $ nuri plan -m model.sfp -a
+Console mode
+------------
+We could enter Nuri console mode and do operations:
+- enter console mode
+
+ $ nuri console
+
+- edit the model which is stored in ~/.nuri/main.sfp
+
+ nuri@user> edit
+
+- compile and print the model
+
+ nuri@user> model
+
+- generate the current state of the system based on the model
+
+ nuri@user> state
+
+- generate the plan
+
+ nuri@user> plan
+
+- orchestrate the execution of any plan generated by Nuri
+
+ nuri@user> plan -a
+
+- choreograph the execution of any plan generated by Nuri
+
+ nuri@user> bsig -a