Skip to content

Commit 92e3af2

Browse files
committed
Updated readme
1 parent 6189879 commit 92e3af2

File tree

1 file changed

+38
-12
lines changed

1 file changed

+38
-12
lines changed

README.md

Lines changed: 38 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,52 @@
1-
This is a starter template for [Ionic](http://ionicframework.com/docs/) projects.
1+
# Ionic-Angular4-Animations
22

3-
## How to use this template
3+
Sample project that shows angular4 animations examples in Ionic.
44

5-
*This template does not work on its own*. The shared files for each starter are found in the [ionic2-app-base repo](https://github.com/ionic-team/ionic2-app-base).
5+
* FrontEnd: Ionic App.
66

7-
To use this template, either create a new ionic project using the ionic node.js utility, or copy the files from this repository into the [Starter App Base](https://github.com/ionic-team/ionic2-app-base).
7+
More examples: [Angular.io](https://angular.io/guide/animations)
88

9-
### With the Ionic CLI:
9+
## Running
1010

11-
Take the name after `ionic2-starter-`, and that is the name of the template to be used when using the `ionic start` command below:
11+
Before you go through this example, you should have at least a basic understanding of Ionic concepts. You must also already have Ionic installed on your machine.
12+
13+
* Test in localhost:
14+
15+
To run it, cd into `ionic-angular4-animations` and run:
16+
17+
```bash
18+
npm install
19+
ionic serve
20+
```
21+
22+
* Test in Android:
1223

1324
```bash
14-
$ sudo npm install -g ionic cordova
15-
$ ionic start myBlank blank
25+
ionic cordova add platform android
26+
ionic cordova run android
1627
```
1728

18-
Then, to run it, cd into `myBlank` and run:
29+
* Test in iOS:
1930

2031
```bash
21-
$ ionic cordova platform add ios
22-
$ ionic cordova run ios
32+
ionic cordova add platform ios
33+
ionic cordova run ios
2334
```
2435

25-
Substitute ios for android if not on a Mac.
2636

37+
## Requirements
38+
39+
* [Node.js](http://nodejs.org/)
40+
* [Ionic Cordova](https://ionicframework.com/docs/intro/installation/)
41+
42+
## License
43+
44+
The MIT License (MIT) Copyright (c)
45+
46+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
47+
48+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
49+
50+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
51+
52+
Original work Copyright (c) 2017 Adrián Brito

0 commit comments

Comments
 (0)