From 49fc7e468783308e11a4e0b3f7d00a2f69fdf700 Mon Sep 17 00:00:00 2001 From: Phil Kunz Date: Fri, 21 Apr 2017 19:06:22 +0200 Subject: [PATCH] update docs --- docs/config.md | 4 +--- docs/default.md | 2 +- docs/examples.md | 8 +++++--- docs/index.md | 4 ++-- docs/install.md | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/config.md b/docs/config.md index 0e8166c..561fef3 100644 --- a/docs/config.md +++ b/docs/config.md @@ -2,9 +2,7 @@ name: config --- # Configuration -## of npmts - -npmts can be configured to your needs: +npmts can be configured to your needs. ### npmextra.json the npmts section in npmextra.json can be used to configure npmts. diff --git a/docs/default.md b/docs/default.md index 994e69e..360ed52 100644 --- a/docs/default.md +++ b/docs/default.md @@ -2,7 +2,7 @@ name: Default Behaviour --- # Default Behaviour -## of npmts +when you don't configure it otherwise. 1. **Config:** Check config in ./npmextra.json (Check out [npmextra](https://www.npmjs.com/package/npmextra)) 1. **Clean:** Clean up from any previous builds (old js files) diff --git a/docs/examples.md b/docs/examples.md index a55f241..9a23ff0 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -2,14 +2,16 @@ name: Examples --- # Examples -## of modules that use npmts +modules that use npmts in theis development workflow Module Name | Description --- | --- +[gitzone](https://www.npmjs.com/package/gitzone) | fast npm module prototyping [gulp-browser](https://www.npmjs.com/package/gulp-browser) | browserify for gulp +[npmdocker](https://www.npmjs.com/package/npmdocker) | dockerized npm development +[smartcli](https://www.npmjs.com/package/smartcli) | easy cli tool creation - -> We will add more options over time. +> There are tons more... We will add them here over time. ### Tips and tricks: diff --git a/docs/index.md b/docs/index.md index 3a73d11..384d848 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,7 @@ name: Start --- # npmts -## Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6. +Write npm modules with TypeScript without hassle. TypeScript ready. Fully ES6. ## Availabililty [![npm](https://gitzone.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/npmts) @@ -39,4 +39,4 @@ This works on your machine and in CI. There is a prebuild docker image available > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html) -[![repo-footer](https://gitzone.gitlab.io/assets/repo-footer.svg)](https://push.rocks) +[![repo-footer](https://gitzone.gitlab.io/assets/repo-footer.svg)](https:/git.zone) diff --git a/docs/install.md b/docs/install.md index 50c68eb..198d35b 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,5 +1,5 @@ # Install npmts -First install npmts globally, then install the npmts-g locally. +Get started with TypeScript awesomeness. > **npmts-g* checks if the global version of npmts suffices the modules requirements. If not it installs npmts locally in the right version during npm install.