Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Genevieve LEsperance committed Jun 20, 2018
1 parent b7c3db7 commit 11eb266
Showing 1 changed file with 19 additions and 6 deletions.
25 changes: 19 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,22 @@

Go cli & library for cleaning up **orphaned IaaS resources**.

* <a href='#why'>Why might you use this?</a>
* <a href='#what'>What's it look like?</a>
* <a href='#why'>Why you might be here.</a>
* <a href='#how'>Installation</a>
* <a href='#usage'>Usage</a>
* [Resources you can delete by IaaS.](RESOURCES.md)



## <a name='why'></a> Why might you use this?
- You `terraform apply`'d way back when and lost your `terraform.tfstate`
- You used the console or cli to create some infrastructure and want to clean up
- Your acceptance tests in CI failed, the container disappeared, and
infrastructure resources were tragically orphaned



## <a name='what'></a>What's it look like?

It will **prompt you before deleting** any resource by default, ie:
Expand Down Expand Up @@ -36,12 +46,15 @@ Or maybe you want to **see all of the resources** in your IaaS, ie:
```


Finally, you might want to delete a single resource type::
```css
> leftovers types
service-account

## <a name='why'></a> Why you might be here.
- You `terraform apply`'d way back when and lost your `terraform.tfstate`
- You used the console or cli to create some infrastructure and want to clean up
- Your acceptance tests in CI failed, the container disappeared, and
infrastructure resources were tragically orphaned
> leftovers --filter banana --type service-account --no-confirm
[Service Account: banana@pivotal.io] Deleting...
[Service Account: banana@pivotal.io] Deleted!
```



Expand Down

0 comments on commit 11eb266

Please sign in to comment.