README.md in heirloom-0.2.0 vs README.md in heirloom-0.3.0.rc1
- old
+ new
@@ -1,31 +1,33 @@
Heirloom
========
-I help building and deploying .tar.gz files to cloud based storage services and tracking meta data about those 'Heirlooms' for easy deployments.
+Heirloom is packages and distributes files to cloud storage services. Heirloom tracks metadata about those deployments, both about the file locations, as well as arbitrary metadata which can be set by an engineer or build process.
-How To Use Heirloom
--------------------
+Installation
+------------
-To get started copy the sample below into .heirloom.yml and update the specified fields.
+First things first, install heirloom:
```
+gem install heirloom
+```
+
+To get started copy the sample below into ~/.heirloom.yml and update the specified fields.
+
+```
aws:
access_key: UPDATE_ME
secret_key: UPDATE_ME
- regions:
- - us-west-1
- - us-west-2
- - us-east-1
- authorized_aws_accounts:
- - UPDATE@ME
- - UPDATE@ME
```
-* **access_key / secret_key**: Account where you would like the Heirlooms storaged.
-* **regions**: AWS regions where the Heirlooms should be uploaded
-* **authorized_aws_accounts**: Heirloom expects you to deploy to seperate accounts from where the Heirloom is stored. authorized_aws_accounts specifices the **email** address of other accounts to be authorized to access private Heirlooms.
+* **access_key / secret_key**: AWS account credentials where you would like the archives stored.
Platforms
---------
-Currently I support s3 and simpledb but would one day like to expand (Big Table, etc).
+Currently I support AWS S3 for object storage and AWS SimpleDB for metadata management. One day I'd like to expand to other providers.
+
+Documentation
+-------------
+
+For more information, please view the [Heirloom Wiki](https://github.com/live-community/heirloom/wiki).