chore(): have separate README for npm package

This commit is contained in:
Tim Lancina
2015-12-18 17:55:18 -06:00
parent b6ec554695
commit 3ab3de56e3
3 changed files with 38 additions and 58 deletions

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

@ -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 `<script>` tag for demos, tests and Javascript playgrounds like [Plunker](http://plnkr.co/).
---------
### Tooling
At the moment, the ionic-framework module exports a single 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