README.md in njord-0.1.0 vs README.md in njord-0.1.1

- old
+ new

@@ -1,14 +1,12 @@ # Njord -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/njord`. To experiment with that code, run `bin/console` for an interactive prompt. +Welcome to Njord. I needed a gem to help me with some common docker and kubernetes tasks so here it is. -TODO: Delete this and the text above, and describe your gem - ## Installation -Add this line to your application's Gemfile: +Add this line to your application's Gemfile, preferably in the test/development section: ```ruby gem 'njord' ``` @@ -20,20 +18,32 @@ $ gem install njord ## Usage -TODO: Write usage instructions here +Njord needs a config file in the directory you want to execute it. -## Development +Just create `.njord.yml` with the content: +```yaml +images: + - image_name: njord/image1 + docker_repo: hub.docker.com + dockerfile: Dockerfile + tagging: git + - image_name: njord/image2 + docker_repo: hub.docker.com + dockerfile: Dockerfile-Http + tagging: git +``` -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. +You can currently use the command `$ njord build`, `$ njord push`. I plan to integrate some k8s commands as well. +The option `tagging` can currently only be `git`. I will add `sem-ver` soon, to enable semantic versioning without user input. -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). +The finished state of Njord should make a workflow possible, that handles building, tagging, pushing, deploying, rolling back and getting logs. ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/njord. +Bug reports and pull requests are welcome on GitHub at https://github.com/DTrierweiler/njord. ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).