README.md in kuberun-0.1.0 vs README.md in kuberun-0.1.1
- old
+ new
@@ -4,17 +4,21 @@
This CLI tool aims to create completely separate pod for those commands without having to manually code its configuration.
Uses `kubectl` inside.
+## Status
+
+This tool is in early alpha stage.
+
## Installation
Dependencies:
* Ruby >= 2.4
* kubectl in `$PATH`
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile (preferably in `development` group):
```ruby
gem 'kuberun'
```
@@ -26,10 +30,12 @@
$ gem install kuberun
## Usage
-TODO: Write usage instructions here
+```
+kuberun help
+```
## 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.
\ No newline at end of file