From 5d4c9f52097a832ae0a692ff0580f645df1fa828 Mon Sep 17 00:00:00 2001 From: Max Lynch Date: Thu, 18 Feb 2016 13:34:22 -0600 Subject: [PATCH] Update README.md --- scripts/npm/README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/scripts/npm/README.md b/scripts/npm/README.md index 87949159b0..c04e8eff8d 100644 --- a/scripts/npm/README.md +++ b/scripts/npm/README.md @@ -4,7 +4,7 @@ The official npm package for [Ionic](http://ionicframework.com/) 2, complete wit To get started with Ionic 2, please read the [Installation](http://ionicframework.com/docs/v2/getting-started/installation/) guide. -### Source files: +### Source files 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. @@ -14,7 +14,13 @@ Usually, the only Javascript file required by the user is `ionic.js`, as everyth import {App, Page} from 'ionic-framework/ionic'; ``` -### Bundles: +### 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 `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 `