diff --git a/README.md b/README.md index dc1f425..8730158 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,6 @@ -# gulp-bootstrap -works with gulp, but does nothing. Use it to bootstrap your own gulp plugin with TypeScript, Travis and npm. - -### Buildstatus/Dependencies -[![Build Status](https://travis-ci.org/pushrocks/gulp-bootstrap.svg?branch=master)](https://travis-ci.org/pushrocks/gulp-bootstrap) -[![devDependency Status](https://david-dm.org/pushrocks/gulp-bootstrap/dev-status.svg)](https://david-dm.org/pushrocks/gulp-bootstrap#info=devDependencies) - -### Usage -This npm package comes with everything you need to start your own gulp plugin. - -Features: - -* TypeScript: Code your plugin in TypeScript -* Use gulp to compile TypeScript without the global gulp CLI Tool. -* Use travis to deploy to npm -* Have a master branch for the latest dev version -* Have a release branch for the latest npm version - -This package **doesn't require global gulp** (just local -> simply do npm install`) to compile TypeScript. - -* to compile TypeScript do `npm test` (You should chain your own tests to this command later on) -* to setup release do `npm run setup` -* to release a patch do `npm run release` - -We recommend using travis for npm releasing and test integration. - -#### The structure - -``` -gulp-bootstrap/ -| -|- ts/ -| |- compile/ -| | |- compile.js **** contains gulp task` -| |- index.ts **** Your main TypeScript file. -| -|- index.js **** the compiled module -``` +# smartfile +make files easily accessible for processing in javascript. +## Supported file types: +* .yml .yaml +* .json