README.md in secret_console-0.2.1 vs README.md in secret_console-0.2.2
- old
+ new
@@ -1,10 +1,11 @@
# SecretConsole
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/secret_console`. To experiment with that code, run `bin/console` for an interactive prompt.
+SecretConsole is a GUI tool for CredStash.
-TODO: Delete this and the text above, and describe your gem
+![SecretConsole Top](https://raw.githubusercontent.com/adorechic/secret_console/doc_images/images/secret_console_top.png)
+![SecretConsole Edit](https://raw.githubusercontent.com/adorechic/secret_console/doc_images/images/secret_console_edit.png)
## Installation
Add this line to your application's Gemfile:
@@ -20,12 +21,15 @@
$ gem install secret_console
## Usage
-TODO: Write usage instructions here
+ $ secret_console
+ $ open http://localhost:4567
+SecretConsole requires an aws credential such as AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
+
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
@@ -36,6 +40,5 @@
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-