README.md in terraforming-0.0.2 vs README.md in terraforming-0.0.3
- old
+ new
@@ -2,10 +2,11 @@
[![Build Status](https://travis-ci.org/dtan4/terraforming.svg?branch=master)](https://travis-ci.org/dtan4/terraforming)
[![Code Climate](https://codeclimate.com/github/dtan4/terraforming/badges/gpa.svg)](https://codeclimate.com/github/dtan4/terraforming)
[![Test Coverage](https://codeclimate.com/github/dtan4/terraforming/badges/coverage.svg)](https://codeclimate.com/github/dtan4/terraforming)
[![Gem Version](https://badge.fury.io/rb/terraforming.svg)](http://badge.fury.io/rb/terraforming)
+[![Docker Repository on Quay.io](https://quay.io/repository/dtan4/terraforming/status "Docker Repository on Quay.io")](https://quay.io/repository/dtan4/terraforming)
Import existing AWS resources into [Terraform](https://terraform.io/) style (tf, tfstate)
## Installation
@@ -114,12 +115,36 @@
}
```
(Probably you have to modify the output to add it to existing `terraforming.tfstate`)
+## Run as Docker container [![Docker Repository on Quay.io](https://quay.io/repository/dtan4/terraforming/status "Docker Repository on Quay.io")](https://quay.io/repository/dtan4/terraforming)
+
+Terraforming Docker Image is available at [quay.io/dtan4/terraforming](https://quay.io/repository/dtan4/terraforming) and developed at [dtan4/dockerfile-terraforming](https://github.com/dtan4/dockerfile-terraforming).
+
+Pull the Docker image:
+
+```bash
+$ docker pull quay.io/dtan4/terraforming:latest
+```
+
+And then run Terraforming as a Docker container:
+
+```bash
+$ docker run \
+ --rm \
+ --name terraforming \
+ -v /path/to/tf-files-dir:/app \
+ -e AWS_ACCESS_KEY_ID=XXXXXXXXXXXXXXXXXXXX \
+ -e AWS_SECRET_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
+ -e AWS_DEFAULT_REGION=xx-yyyy-0 \
+ quay.io/dtan4/terraforming:latest \
+ terraforming s3
+```
+
## Development
-After checking out the repo, run `scripts/setup` to install dependencies. Then, run `scripts/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `script/setup` to install dependencies. Then, run `script/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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing