From 7dccc0bdbbe4f5ee1ff1c172aad8976386c52928 Mon Sep 17 00:00:00 2001 From: Tim Lancina Date: Tue, 6 Oct 2015 13:38:52 -0500 Subject: [PATCH] create README for npm package Closes #71. --- gulpfile.js | 3 ++- scripts/npm/README.md | 26 ++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 scripts/npm/README.md diff --git a/gulpfile.js b/gulpfile.js index d4f0ec8c45..808c405ff8 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -447,7 +447,8 @@ gulp.task('publish', function(done) { function() { var packageJSONTemplate = _.template(fs.readFileSync('scripts/npm/package.json')); packageJSONContents = packageJSONTemplate({ 'version': version, 'ngVersion': ngVersion }); - fs.writeFileSync("dist/package.json", packageJSONContents); + fs.writeFileSync('dist/package.json', packageJSONContents); + fs.writeFileSync('dist/README.md', fs.readFileSync('scripts/npm/README.md')); // publish to npm exec('cd dist && npm publish', function (err, stdout, stderr) { diff --git a/scripts/npm/README.md b/scripts/npm/README.md new file mode 100644 index 0000000000..e64f6cce79 --- /dev/null +++ b/scripts/npm/README.md @@ -0,0 +1,26 @@ +Ionic Framework +========= +https://github.com/driftyco/ionic2 + +Bundles: + - `css/` + - the Ionic CSS stylesheet + - `fonts/` + - Ionicons and Roboto fonts + - `js/` + - `ionic.js` the Ionic module, in System register format + - `ionic.bundle.js` the Ionic bundle, contains: + * traceur-runtime.js + * es6-module-loader.js + * system.js + * angular2.dev.js + * router.dev.js (angular2 router) + * ionic.js + * web-animations.min.js + - `web-animations.min.js` web animations API polyfill + +Source files: + - `src/es5` - Ionic ES5 source files in both CommonJS and System module formats + - `src/es6` - Ionic ES6 source files + - `src/ts` - Ionic TypeScript source files (typings still missing) + - `scss` - Ionic Sass source files