javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-20 12:29:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Max Lynch
2016-02-18 13:34:22 -06:00
parent ce0e875a8f
commit 5d4c9f5209
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
scripts/npm/README.md
View File

@ -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 `<script>` tag for demos, tests and Javascript playgrounds like [Plunker](http://plnkr.co/).
### Installation and More
To use Ionic 2, we recommend installing and utilizing the Ionic CLI which will help you create pre-configured Ionic apps.
For full instructions on using Ionic 2, please visit the [Ionic 2 Documentation](http://ionicframework.com/docs/v2/)