Improve README

README.md

@@ -1,53 +1,76 @@
-# botkube
-[![Build Status](https://travis-ci.org/infracloudio/botkube.svg?branch=master)](https://travis-ci.org/infracloudio/botkube)
+# BotKube
+[![Build Status](https://travis-ci.org/infracloudio/botkube.svg?branch=master)](https://travis-ci.org/infracloudio/botkube) [![Go Report Card](https://goreportcard.com/badge/github.com/infracloudio/botkube)](https://goreportcard.com/report/github.com/infracloudio/botkube)
 
-A slack bot which watches your kubernetes clusters and notifies about resources life cycles, errors, events and provide recommendations about the best practices while creating resources.
-You can also ask botkube to execute kubectl commands on k8s cluster which helps debugging a application or cluster.
+For complete documentation visit www.botkube.io
 
-## Building
-```
-build/docker.sh <docker-repo> <tag>
-```
+A slack bot which keeps eye on your kubernetes resources and notifies about resources life cycles events, errors and warnings. It allows you to define and run certain checks on resouces specs.
+You can also ask BotKube to execute kubectl commands on k8s cluster which helps debugging an application or cluster.
+
+## Getting started
+### Install BotKube app to your slack workspace
+Click the "Add to Slack" button provided to install `BotKube` slack application to your workspace. Once you authorized the application, you will be provided a BOT Access token. Kindly note down that token which will be required while deploying BotKube controller to your cluster
+
+<a href="https://slack.com/oauth/authorize?scope=bot&client_id=12637824912.515475697794"><img alt="Add to Slack" height="40" width="139" src="https://platform.slack-edge.com/img/add_to_slack.png" srcset="https://platform.slack-edge.com/img/add_to_slack.png 1x, https://platform.slack-edge.com/img/add_to_slack@2x.png 2x" /></a>
+
+### Add BotKube to a slack channel
+After installing BotKube app to your slack workspace, you could see new bot user with name 'BotKube' create in your workspace. Add that bot to a slack channel you want to receive notification in. (You can add it by inviting using `@BotKube` message in a required channel)
+
+### Installing BotKube controller to your kubernetes cluster
 
-## Creating slack bot
-- Create a bot with name `botkube` https://my.slack.com/services/new/bot
-- Set icon, name and copy API token (required to configure botkube)
-- Add the bot into a channel by inviting with `@botkube` in the message area
-
-## Configuration
-Kubeops reads configurations from `config.yaml` file placed at `CONFIG_PATH`
-e.g https://github.com/infracloudio/botkube/config.yaml
-
-Supported resources for configuration:
-- pods
-- nodes
-- services
-- namespaces
-- replicationcontrollers
-- persistentvolumes
-- persistentvolumeclaims
-- secrets
-- configmaps
-- deployments
-- daemonsets
-- replicasets
-- ingresses
-- jobs
-- roles
-- rolebindings
-- clusterroles
-- clusterrolebindings
-
-## Installing on kubernetes cluster
-### Using helm
-- Follow https://docs.helm.sh/using_helm/#installing-helm guide to install helm.
-- Clone the botkube github repository.
+#### Using helm
+
+- We will be using [helm](https://helm.sh/) to install our k8s controller. Follow [this](https://docs.helm.sh/using_helm/#installing-helm) guide to install helm if you don't have it installed already
+- Clone the BotKube github repository.
+```bash
+$ git clone https://github.com/infracloudio/botkube.git
 ```
-git clone https://github.com/infracloudio/botkube.git
+
+- Update default **config** in **helm/botkube/values.yaml** to watch the resources you want. (by default you will receive **create**, **delete** and **error** events for all the resources in all the namespaces.)
+If you are not interested in events about perticular resource, just remove it's entry from the config file.
+- Deploy BotKube controller using **helm install** in your cluster.
+```bash
+$ helm install --name botkube --namespace botkube --set config.communications.slack.channel={SLACK_CHANNEL_NAME},config.communications.slack.token={SLACK_API_TOKEN_FOR_THE_BOT},config.settings.clustername={CLUSTER_NAME},config.settings.allowkubectl={ALLOW_KUBECTL} helm/botkube/
 ```
-- Update default `botkubeconfig` in `helm/botkube/values.yaml` to watch the resources you want.
-- Deploy botkube using `helm install` in your cluster.
+
+  where,<br>
+  **SLACK_CHANNEL_NAME** is the channel name where @BotKube is added<br>
+  **SLACK_API_TOKEN_FOR_THE_BOT** is the Token you received after installing BotKube app to your slack workspace<br>
+  **CLUSTER_NAME** is the cluster name set in the incoming messages<br>
+  **ALLOW_KUBECTL** set true to allow kubectl command execution by BotKube on the cluster<br>
+
+  Configuration syntax is explained [here](www.botkube.io/configuration).
+
+- Send **@BotKube ping** in the channel to see if BotKube is running and responding.
+
+#### Using kubectl
+
+- Make sure that you have kubectl cli installed and have access to kubernetes cluster
+- Download deployment specs yaml
+
+```bash
+$ wget -q https://raw.githubusercontent.com/infracloudio/botkube/master/deploy-all-in-one.yaml
 ```
-helm install --name botkube --namespace botkube --set botkubeconfig.communications.slack.channel={SLACK_CHANNEL_NAME} --set botkubeconfig.communications.slack.token={SLACK_API_TOKEN_FOR_THE_BOT} helm/botkube/
+
+- Open downloaded **deploy-all-in-one.yaml** and update the configuration.
+  Set *SLACK_CHANNEL*, *SLACK_API_TOKEN*, *clustername*, *allowkubectl* and update the resource events configuration you want to receive notifications for in the configmap.
+
+  where,<br>
+  **SLACK_CHANNEL** is the channel name where @BotKube is added<br>
+  **SLACK_API_TOKEN** is the Token you received after installing BotKube app to your slack workspace<br>
+  **clustername** is the cluster name set in the incoming messages<br>
+  **allowkubectl** set true to allow kubectl command execution by BotKube on the cluster<br>
+
+  Configuration syntax is explained [here](www.botkube.io/configuration).
+
+- Create **botkube** namespace and deploy resources
+
+```bash
+$ kubectl create ns botkube && kubectl create -f deploy-all-in-one.yaml -n botkube
 ```
-- Send `@botkube help` in the channel to see if `botkube` is responding.
+
+- Check pod status in botkube namespace. Once running, send **@BotKube ping** in the slack channel to confirm if BotKube is responding correctly.
+
+
+Follow [this](https://www.botkube.io/installation/) for complete BotKube installation guide.
+
+Visit www.botkube.io for Configuration, Usage and Examples.