javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2026-03-13 10:22:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

Chore(readme): Update readme for usage of CLI and generators. Update API docs on usage.

Browse Source
This commit is contained in:
jbavari
2015-11-02 18:00:34 -07:00
parent 32eb21524a
commit 3e216aca0a
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -53,7 +53,12 @@ We are also building out a number of starter projects, including the Ionic 2 sta
### 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.
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 (also use `g` as an alias).
#### Usage:
* `ionic generate page MyPage` - Generate a basic page HTML, JS, and SCSS files.
* `ionic g tabs MyTabPage` - Generate a page with tabs and the tab pages with those.
#### Methods
@@ -64,7 +69,7 @@ Creates the js, html, and scss file for a new page, based on the supplied [Gener
- **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` -
- `name` - the name of the component to generate.
Example:
```
@@ -75,5 +80,5 @@ Example:
#### Generators
- `page`, a blank page
- `tabs`, a page with tab navigation
- `sidemenu`
- `directive`, an Angular2 directive