From e8fe4f1720d82b196f6ced720f90fbd408f2d524 Mon Sep 17 00:00:00 2001
From: Phil Kunz <gitlab@philkunz.com>
Date: Mon, 31 Jul 2017 14:36:33 +0200
Subject: [PATCH] update docs and description

---
 docs/getstarted.md | 38 ++++++++++++++++++++++++++++++++++++++
 docs/index.md      |  5 +++--
 package.json       |  2 +-
 readme.md          |  2 +-
 4 files changed, 43 insertions(+), 4 deletions(-)
 create mode 100644 docs/getstarted.md

diff --git a/docs/getstarted.md b/docs/getstarted.md
new file mode 100644
index 0000000..43fabb3
--- /dev/null
+++ b/docs/getstarted.md
@@ -0,0 +1,38 @@
+---
+name: Get Started
+description: learn how to quickly write npm TypeScript modules
+---
+# Get Started with NPMTS
+and learn how to quickly write npm TypeScript modules
+
+## Step1: Install the tools
+
+To use npmts install it using npm or yarn:
+
+```shell
+npm install -g npmts # install with npm
+yarn global add npmts # install with yarn
+```
+
+For the puspose of getting started quickly also install **gitzone**.
+It'll proovide awesome scaffolding for new npmts npm modules and also updates them later on. 
+
+```shell
+npm install -g gitzone # install with npm
+yarn global add gitzone # install with yarn
+```
+
+You can make sure npmts and gitzone are installed correctly by typing `npmts -v && gitzone -v`.
+
+## Scaffold a new module
+
+To scaffold a new module type
+
+```shell
+gitzone template npm
+```
+
+This will run you through a series of question to get gitzone to know the specifics of your module.
+Enter all information accordingly.
+
+## Run NPMTS for the first time
diff --git a/docs/index.md b/docs/index.md
index 6652099..1d20749 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,8 +1,9 @@
 ---
-name: Start
+name: Index
+description: best practice npm TypeScript modules
 ---
 # npmts
-Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
+best practice npm TypeScript modules
 
 ## Availabililty
 [![npm](https://gitzone.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmts)
diff --git a/package.json b/package.json
index 0e9b14a..e391d4a 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "npmts",
   "version": "8.0.1",
-  "description": "Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.",
+  "description": "best practice npm TypeScript modules",
   "main": "dist/index.js",
   "bin": {
     "npmts": "assets/cliNpmts.js"
diff --git a/readme.md b/readme.md
index 1b8b3c7..502d030 100644
--- a/readme.md
+++ b/readme.md
@@ -1,5 +1,5 @@
 # npmts
-Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6.
+best practice npm TypeScript modules
 
 ## Availabililty
 [![npm](https://gitzone.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmts)