README.md in kite-1.0.2 vs README.md in kite-1.0.4

- old
+ new

@@ -1,14 +1,15 @@ # Kite -![Build Status](https://ci.helioscloud.com/api/v1/teams/heliostech/pipelines/kite/jobs/build-master/badge) -[![Build Status](https://travis-ci.org/helios-technologies/kite.svg?branch=master)](https://travis-ci.org/helios-technologies/kite) -[![codecov](https://codecov.io/gh/helios-technologies/kite/branch/master/graph/badge.svg)](https://codecov.io/gh/helios-technologies/kite) +[![Gem Version](https://badge.fury.io/rb/kite.svg)](https://badge.fury.io/rb/kite) +[![license](https://img.shields.io/github/license/rubykube/kite.svg)](https://github.com/rubykube/kite/blob/master/LICENSE.md) +[![Build Status](https://travis-ci.org/rubykube/kite.svg?branch=master)](https://travis-ci.org/rubykube/kite) +[![codecov](https://codecov.io/gh/rubykube/kite/branch/master/graph/badge.svg)](https://codecov.io/gh/rubykube/kite) Kite is a CLI for scaffolding and managing devops modules -The main purpose is templating of various tools for devops around terraform, bosh, ansible +The main purpose is templating of various tools for devops around terraform, bosh, ansible. Currently Kite supports modular stacks(Kite modules) on both AWS and GCP. We plan in adding community stack using a simple template repository structure. ## Installation @@ -29,11 +30,11 @@ ## Usage To start using kite for bootstraping your infrastructure follow the steps below. -[Note] Most kite commands can be referred by their first letter(for example kite generate environment test == kite g e test) +[Note] Most kite commands can be referred by their first letter(for example `kite generate environment test` is the same as `kite g e test`) ### Create your Infrastructure as Code base repository Create a new kite project using: @@ -55,14 +56,15 @@ Now the environment should be generated at `config/environments/*env_name*` ### Add a module to your environment -To add a Kite module to your environment, you should first initialize it: +To add a Kite module to your environment, you should first initialize it. +It's recommended to use specific module versions/tags(master branch would be used by default): ``` - kite module init https://url.for/your/module --env *env_name* + kite module init https://url.for/your/module --env *env_name* --version *x.y.z/x-y-stable* ``` This should clone module's source files into `modules/*module_name*` and create a `vars.*module_name*.yml` file with all variables needed by the module. Fill in `vars.*module_name*.yml` with correct values and render the module: @@ -78,10 +80,11 @@ ``` gcloud auth application-default login ``` ``` + kite terraform init kite terraform apply --env *env_name* ``` ## Getting help @@ -105,6 +108,6 @@ $ ruby -Ilib ./bin/concourse/in ``` ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/helios-technologies/kite. +Bug reports and pull requests are welcome on GitHub at https://github.com/rubykube/kite.