git.zone/tscoverage
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Philipp Kunz 2017-04-21 19:06:22 +02:00
parent 7ee0c349e3
commit 49fc7e4687
5 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/config.md
View File

@ -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.

2
docs/default.md
View File

@ -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)

8
docs/examples.md
View File

@ -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:

4
docs/index.md
View File

@ -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)

2
docs/install.md
View File

@ -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.