From 3ab3de56e31994450c9fae319c5f53d68b68b680 Mon Sep 17 00:00:00 2001 From: Tim Lancina Date: Fri, 18 Dec 2015 17:55:18 -0600 Subject: [PATCH] chore(): have separate README for npm package --- README.md | 57 ------------------------------------------- gulpfile.js | 2 +- scripts/npm/README.md | 37 ++++++++++++++++++++++++++++ 3 files changed, 38 insertions(+), 58 deletions(-) create mode 100644 scripts/npm/README.md diff --git a/README.md b/README.md index 67ddff606c..4ba33666bb 100644 --- a/README.md +++ b/README.md @@ -14,61 +14,4 @@ To try Ionic 2 today, visit the [Ionic 2 Docs](http://ionicframework.com/docs/v2 There are a few real Ionic 2 apps in the wild. The most complete is the [Ionic Conference App](https://github.com/driftyco/ionic-conference-app), a perfect starting point for building your own conference app. -## Distribution - - [npm: ionic-framework](https://www.npmjs.com/package/ionic-framework) - -## Ionic Framework Package - The ionic-framework package comes with both frontend dependencies, located in 'dist', and a Node API, located in 'tooling'. - -### 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: - - 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 - ---------- - -### Tooling - - At the moment, ionic-framework exports one function, `generate`, that can be used to scaffold new pages in an Ionic app. It is used by the [Ionic CLI's](https://github.com/driftyco/ionic-cli) `generate` command. - -#### Methods - -`generate(config)` - -Creates the js, html, and scss file for a new page, based on the supplied [Generator](#generators). - -- **config** (Object) Config object, with the following options: - - `appDirectory` - root directory of the Ionic project - - `generator` - which [generator](#generators) to use, default is `page`. - - `name` - the name of the component to generate. - -Example: - ``` - var ionic = require('ionic-framework'); - ionic.generate({ appDirectory: process.cwd(), generator: 'tabs', name: 'MyTabsPage' }) - ``` - -#### Generators -- `page`, a blank page -- `tabs`, a page with tab navigation - diff --git a/gulpfile.js b/gulpfile.js index 9ea32607a6..d1dd9f6cb1 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -401,7 +401,7 @@ gulp.task('package', ['src'], function(){ return gulp.src([ 'scripts/npm/.npmignore', 'scripts/npm/package.json', - 'README.md' + 'scripts/npm/README.md' ]) .pipe(gulp.dest('dist')); }); diff --git a/scripts/npm/README.md b/scripts/npm/README.md new file mode 100644 index 0000000000..2f42aeeaf3 --- /dev/null +++ b/scripts/npm/README.md @@ -0,0 +1,37 @@ +## Ionic Framework Package + The ionic-framework package comes with both Javascript and Sass frontend dependencies, located in `dist/`, and a Node API, located in `tooling/`. + +### Source files: + +ES5 sources in the CommonJS module format, their associated Typescript type definition files, and the Ionic Sass entry files are located in `dist/`. The Javascript sources are meant to be used by a bundler such as Webpack, SystemJS Builder, or Browserify. The type definitions provide support to Typescript tooling for things like type checking and code completion. + +### Bundles: + +Minified and unminified CommonJS and System.register module format bundles, as well as compiled CSS stylesheets for both Ionic iOS and Material Design are located `dist/bundles/`. These can also be used with bundlers to a certain extent, for example, using Webpack's [`externals option`](https://webpack.github.io/docs/configuration.html#externals). The SystemJS bundle is primarily meant to be included in a `