8.0.2

docs/changelog.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 2017-07-30: Version 7.x.x -> 8.x.x
+Testfiles in ./test/ can now import files directly from the ts dir:
+
+```javascript
+// ./test/test.ts
+import * as myModule from '../ts/index
+```

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

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)

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "npmts",
-  "version": "8.0.0",
+  "version": "8.0.2",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,7 +1,7 @@
 {
   "name": "npmts",
-  "version": "8.0.0",
+  "version": "8.0.2",
-  "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"

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)
@@ -38,6 +38,9 @@ For more information about how to best write tap tests check out the [tapbundle
 This works on your machine and in CI. There is a prebuild docker image available that includes npmts to make CI a breeze:  
 [hosttoday/ht-docker-node:npmts on Dockerhub](https://hub.docker.com/r/hosttoday/ht-docker-node/)
 
+## Changelog
+For breaking changes please see the [changelog](https://gitzone.gitlab.io/npmts/changelog.html).
+
 For further information read the linked docs at the top of this README.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)