README.md in floe-0.0.1 vs README.md in floe-0.1.0
- old
+ new
@@ -1,29 +1,46 @@
# Floe
-TODO: Write a gem description
+[](https://github.com/ManageIQ/floe/actions/workflows/ci.yaml)
-## Installation
+## Overview
-Add this line to your application's Gemfile:
+Floe is a runner for [Amazon States Language](https://states-language.net/) workflows with support for Docker resources and running on Docker, Podman, or Kubernetes.
- gem 'floe'
+## Installation
-And then execute:
+Install the gem and add to the application's Gemfile by executing:
- $ bundle
+ $ bundle add floe
-Or install it yourself as:
+If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install floe
## Usage
-TODO: Write usage instructions here
+Floe can be run as a command-line utility or as a ruby class.
+### Command Line
+
+```
+bundle exec ruby exe/floe --workflow examples/workflow.asl --inputs='{"foo": 1}'
+```
+
+### Ruby Library
+
+```ruby
+require 'floe'
+
+workflow = Floe::Workflow.load(File.read("workflow.json"))
+workflow.run!
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
## Contributing
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Bug reports and pull requests are welcome on GitHub at https://github.com/ManageIQ/floe.