README.md in simplerubysteps-0.0.6 vs README.md in simplerubysteps-0.0.7
- old
+ new
@@ -5,65 +5,61 @@
This is software in the experimental stage and should not really be used by anyone. Be warned.
## Installation
Prerequisites (for alpha version):
-* Linux-like environment (the deployment tools are currently implemented with shell scripts)
* AWS CLI installed
-Add this line to your application's Gemfile:
+## Usage
-```ruby
-require "simplerubysteps"
+### Install the gem and the simplerubysteps CLI
+
```
+gem install simplerubysteps
+```
-And install the gem:
-
- $ gem install simplerubysteps
-
-## Usage
-
### Create AWS Step Functions State Machine with ruby DSL
```
cd samples/sample1
vi workflow.rb
```
-### Create CloudFormation stack with Step Functions State Machine and supporting Lambda functions
+### Create CloudFormation stack with Step Functions State Machine and supporting Lambda function
```
export AWS_PROFILE=...
cd samples/sample1
-simplerubysteps-deploy
+simplerubysteps deploy
```
### Trigger State Machine Execution and wait for completion
```
export AWS_PROFILE=...
cd samples/sample1
-echo '{"foo": "James Bond"}' | simplerubysteps-workflow-run
+
+./start-directbranch.sh
+
+./sample-task-worker.sh &
+./start-callbackbranch.sh
```
### Delete CloudFormation stack
```
export AWS_PROFILE=...
cd samples/sample1
-simplerubysteps-destroy
+simplerubysteps destroy
```
## Development
-After checking out the repo, run `bin/setup` to install dependencies.
-
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
### TODOs
-* Custom IAM role policies (Step Functions and Lambda)
-* sls-like tooling in ruby with AWS SDK
+* Custom IAM policies per Lambda task
* Workflow action unit test support
* ...
## Contributing