From e7b64b987fabe8d1996d25d8c23d458983e89eac Mon Sep 17 00:00:00 2001 From: Senad Uka Date: Mon, 22 Feb 2016 03:57:12 +0100 Subject: [PATCH] readme --- web/README.md | 31 ++++--------------------------- 1 file changed, 4 insertions(+), 27 deletions(-) diff --git a/web/README.md b/web/README.md index d18ba6e..9dc9c62 100644 --- a/web/README.md +++ b/web/README.md @@ -1,28 +1,5 @@ -=== README +# CHUB - Configuration HUB -This README would normally document whatever steps are necessary to get the -application up and running. - -Things you may want to cover: - -* Ruby version - -* System dependencies - -* Configuration - -* Database creation - -* Database initialization - -* How to run the test suite - -* Services (job queues, cache servers, search engines, etc.) - -* Deployment instructions - -* ... - - -Please feel free to use a different markup language if you do not plan to run -rake doc:app. +CHUB is a tool that helps administrators keep the servers configuration in a repository agnostic of the platform the server is running on. +It is built to be easily augmented by adding templates and building syntax checking plugins. +Advanced administrators can use it as a repository and a backup tool, while it helps beginners by providing a starting points and guidance for editing complex configurations.