create README for npm package

Closes #71.
This commit is contained in:
Tim Lancina
2015-10-06 13:38:52 -05:00
parent b19d72b7da
commit 7dccc0bdbb
2 changed files with 28 additions and 1 deletions

View File

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

26
scripts/npm/README.md Normal file
View File

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