omproved readme

This commit is contained in:
Philipp Kunz 2016-01-16 14:09:33 +01:00
parent 24f9e5e982
commit ef314f5b2d
3 changed files with 25 additions and 0 deletions

23
README.md Normal file
View File

@ -0,0 +1,23 @@
# npmts
Write npm modules with TypeScript withour hassle.
## How to use npmts
### Install
First install npmts as dev dependency:
```sh
npm install npmts --save-dev
```
Then use it in package.json's script section to trigger a build:
```json
"scripts": {
"test": "npmts"
}
```
### Default behaviour
by default npmts looks in your `./ts/` directory for an `index.ts` and a `test.ts` that will compile to
./index.js and ./test.js

View File

@ -10,6 +10,8 @@ var paths = {};
paths.cwd = plugins.smartcli.get.cwd().path; paths.cwd = plugins.smartcli.get.cwd().path;
paths.indexTS = plugins.path.join(paths.cwd, "ts/index.ts"); paths.indexTS = plugins.path.join(paths.cwd, "ts/index.ts");
paths.testTS = plugins.path.join(paths.cwd, "ts/test.ts"); paths.testTS = plugins.path.join(paths.cwd, "ts/test.ts");
plugins.gulp.task("indexTS", function () { plugins.gulp.task("indexTS", function () {
plugins.gulp.src(paths.indexTS) plugins.gulp.src(paths.indexTS)
.pipe(plugins.gulpTypeScript({ .pipe(plugins.gulpTypeScript({

0
ts/npmts.default.ts Normal file
View File