Merge pull request #132 from aerogear/docs

docs: provide top level project documentation

README.md

@@ -13,9 +13,56 @@
 </p>
 
 
+## Introduction
 
 
-> NOTE: Project is under construction
+Charmil provides ecosystem of tools to build production ready command line tools with Cobra Framework.
+
+
+### Architecture
+
+Charmil provides a way to build a CLI ecosystem where developers can build multiple fragmented CLI's in various repositories 
+and embed them later in the single host CLI. Charmil provides core base functionality that helps to abstract various elements 
+of the CLI ecosystem:
+
+- Logging
+- Authentication
+- Configuration
+- Commands and Flags standards.
+
+Charmil SDK will typically be introduced into two different CLI
+
+- Host CLI - CLI that is being used by end user that can embed one or more Plugins CLI
+- Plugins CLI - Separate CLI that can be also embedded into host CLI
+
+
+## Components
+
+### Charmil Plugin framework starter template 
+
+Creating Golang CLI should be easy and fast. 
+Charmil starter template provides fast way to build plugin and host commands that use Charmil SDK and Validator.
+Starter template contains all tools and solutions required to build command line tool
+
+### Charmil SDK
+
+Framework for building modular, multi repo Golang CLI's with Cobra 
+Number of high level implementations for individual CLI creators for common problems like configuration, authentication and internationalization
+Provides ability to embed modular CLI into hosts CLI at compile time.
+
+### Charmil Validator
+
+Charmil Validator gives developers the ability to validate a group of their cobra commands against common practices. 
+Validator can check if commands are providing proper documentation, doesn't have overriden flags or provide shell completions. 
+Validator can be used as go unit test and run during CI/CD that simplifies review of CLI's that contain commands that are hosted in multiple repositories.
+
+
+### Charmil Command Registry
+
+Charmil command registry lets you provide external index of the command line tools that can be installed dynamically and embeeded into your host CLI.
+Developers can create CLI profiles to install multiple individual CLI's at the same time and keep them updated with various backends like Kubernetes/OpenShift etc.
+
+> Under Construction
 
 ## Documentation