From 35c742ddd862f86f00cea91d47e205b3119a67c2 Mon Sep 17 00:00:00 2001
From: bjoern <me@tentakelfabrik.de>
Date: Mon, 26 Nov 2018 21:37:16 +0100
Subject: [PATCH] adding docs

---
 docs/index.rst | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/docs/index.rst b/docs/index.rst
index e69de29..2437da9 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -0,0 +1,45 @@
+# Cripsy-Boilerplate - Less is more
+
+Flat Sass Boilerplate gives you an amount of basic settings, components, helpers, mixins and functions.
+
+The problem of most frameworks is they trying to hard adding a lot of styles, which has to be customized and documented
+if you used it for a Project. Often these changes cause a loss of performance and raise the propability of errors.
+
+[Documentation](https://crispy-boilerplate.readthedocs.io/en/latest/)
+
+## Coding Style
+
+The boilerplate uses as coding style [http://getbem.com/](BEM), but as a more simpler idea of it. One of the benefits of BEM is that you create components and can reuse them. But one the other hand it can be really strange if you overthinking it.
+
+## Not Fancy but Small
+
+Components are created to give you a structure and a basic set of styles and not to look fancy. The idea is to extend each component and save time to write a bunch of extra CSS code and therefore get more performance while minimize the causes of errors. Of Course is really Fancy to get more Performance and less Errors.
+
+## Getting Started
+
+```
+npm install crispy-boilerplate
+```
+
+Main SCSS-File:
+
+```
+@import
+    "crispy";
+```
+
+After this, include Mixins you need:
+
+```
+@include crispy__*()
+```
+
+To overwrite defaults simple add your own config-file after importing crispy:
+
+```
+@import
+    "crispy",
+    "config";
+```
+
+## Typography