From bc82c4c33739e4796205e17c99181d8da4eb377a Mon Sep 17 00:00:00 2001 From: Tim Lancina Date: Fri, 18 Dec 2015 18:15:12 -0600 Subject: [PATCH] update README.md --- scripts/npm/README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/scripts/npm/README.md b/scripts/npm/README.md index 2f42aeeaf3..8c0287b45b 100644 --- a/scripts/npm/README.md +++ b/scripts/npm/README.md @@ -1,13 +1,19 @@ ## 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/`. + The ionic-framework package comes with both Javascript and Sass frontend dependencies, located in the root of the package, 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. +In the root of the package are ES5 sources in the CommonJS module format, their associated Typescript type definition files, and the Ionic Sass entry files. 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. + +Usually, the only Javascript file required by the user is `ionic.js`, as everything from Ionic can be imported from this file: + +``` + import {App, Page} from 'ionic-framework/ionic'; +``` ### 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 `