Skip to content

Commit

Permalink
Some basic install/usage instructions in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
apparentlymart committed Aug 11, 2015
1 parent ab17bd4 commit cfa41e4
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,19 @@
It could be useful for using Terraform to deploy a static website to S3's website publishing feature.

This utility just generates the ``aws_s3_bucket_object`` configurations. It's up to the user to separately create the bucket into which the objects will be placed.

## Installing

Pretty standard Go program:

* ``go get github.com/saymedia/terraform-s3-dir``
* ``go install github.com/saymedia/terraform-s3-dir``

## Usage

```
Usage: terraform-s3-dir [-h] [-x glob patterns to exclude] <root dir> <bucket name>
-h, --help
-x, --exclude=glob patterns to exclude
```

0 comments on commit cfa41e4

Please sign in to comment.