From 1cb22398ca4b839a56bc40bbe1b8a9bdae49b0ad Mon Sep 17 00:00:00 2001
From: softprops <d.tangren@gmail.com>
Date: Sun, 2 Jun 2019 23:59:54 -0400
Subject: [PATCH] readme

---
 Cargo.lock |  2 +-
 README.md  | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 61 insertions(+), 1 deletion(-)

diff --git a/Cargo.lock b/Cargo.lock
index d0b674b..d90fe19 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -1231,7 +1231,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 
 [[package]]
 name = "stack-tail"
-version = "0.1.0"
+version = "0.0.0"
 dependencies = [
  "chrono 0.4.6 (registry+https://github.com/rust-lang/crates.io-index)",
  "chrono-tz 0.5.1 (registry+https://github.com/rust-lang/crates.io-index)",
diff --git a/README.md b/README.md
index 8c6c07a..0a6c548 100644
--- a/README.md
+++ b/README.md
@@ -2,4 +2,64 @@
 
 > 🥞 ☁️ A CLI interface for monitoring the state and progress of [AWS CloudFormation](https://aws.amazon.com/cloudformation/) stacks
 
+## 🤔 about
+
+Despite leveraging virtuous a continously deployment model for your application and infrastructure
+you may find yourself curious about the current state of your Cloudformation stack. Visiting 
+the AWS console can pull you out of your _flow_ using the aws cli can put a strain on your eyes. 
+`stack-tail` is meant to fill the cap and draw a quick and clear picture to understanding the state
+of your stack.
+
+# 📦 install
+
+TBD
+
+# 🤸 usage
+
+This tool communicates with AWS CloudFormation API's using the standard AWS credential chain
+to authenticate requests. You may wish to export an `AWS_PROFILE` env variable to query your stacks from different accounts or different regions.
+
+The main usecase for this cli tailing the state of a CloudFormation stack
+
+```sh
+USAGE:
+    stack-tail [FLAGS] [OPTIONS] <stack_name>
+
+FLAGS:
+    -f, --follow       Follow the state of progress in changes to a stack until stack completion or failure
+    -h, --help         Prints help information
+    -r, --resources    Report summarized state for stack resources
+    -V, --version      Prints version information
+
+OPTIONS:
+    -t, --timezone <timezone>    Display timestamps adjusted for the provided timezone.
+                                 See list of supported timezones here
+                                 https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List
+
+ARGS:
+    <stack_name>
+
+## events
+
+The default view is a list of stack update events
+
+```sh
+$ stack-tail my-stack-name
+```
+
+## resources
+
+In some cases you may wish to only want to get a picture of the aggregate list of stack resources
+you can use the `--resources` or `-r` to get this view
+
+```sh
+$ stack-tail -r my-stack-name
+```
+
+
+# 👩‍🏭 development
+
+This is a [rustlang](https://www.rust-lang.org/en-US/) application.
+Go grab yourself a copy with [rustup](https://rustup.rs/).
+
 Meetup Inc 2019
\ No newline at end of file