Skip to content

Commit 2ed0e12

Browse files
chore(readme): update description and add circle badge
1 parent 41ca5b3 commit 2ed0e12

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

README.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,38 @@
11
[![npm version](https://badge.fury.io/js/ionic-angular.svg)](https://badge.fury.io/js/ionic-angular)
22
[![Issue Stats](http://issuestats.com/github/driftyco/ionic/badge/pr?style=flat)](http://issuestats.com/github/driftyco/ionic)
33
[![Issue Stats](http://issuestats.com/github/driftyco/ionic/badge/issue?style=flat)](http://issuestats.com/github/driftyco/ionic)
4+
[![Circle CI](https://circleci.com/gh/driftyco/ionic.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/driftyco/ionic)
45

5-
# Ionic 2
6+
# Ionic
67

7-
Ionic 2 is the next generation of [Ionic](http://ionicframework.com/), the open-source mobile app development SDK that makes it easy to build top quality native and progressive web apps with web technologies.
8+
[Ionic](http://ionicframework.com/) is the open-source mobile app development framework that makes it easy to
9+
build top quality native and progressive web apps with web technologies.
810

9-
Ionic 2 is based on the new [2.x version of Angular](https://angular.io/), and comes with many significant performance, usability, and feature improvements.
11+
Ionic is based on [Angular](https://angular.io/) and comes with many significant performance, usability, and
12+
feature improvements over the past versions.
1013

11-
See the [Building apps with Ionic 2](http://adamdbradley.github.io/building-with-ionic2) slides for a quick overview of Ionic 2.
14+
See the [Building Apps with Ionic 2](http://adamdbradley.github.io/building-with-ionic2) slides for a quick
15+
overview of Ionic.
1216

13-
### Getting Started with Ionic 2
17+
### Getting Started
1418

15-
To use Ionic 2 today, visit the [Ionic 2 Docs](http://ionicframework.com/docs/v2/). We would love any feedback you have or to know when you encounter issues, by filing an issue report on this repo.
19+
Start a new project by following our quick [Getting Started guide](http://ionicframework.com/getting-started/).
20+
We would love to hear from you! If you have any feedback or run into issues using our framework, please file
21+
an [issue](https://github.com/driftyco/ionic/issues/new) on this repository.
1622

17-
### Contributing to Ionic 2
23+
### Contributing
1824

19-
See [CONTRIBUTING.md](https://github.com/driftyco/ionic/blob/master/.github/CONTRIBUTING.md)
25+
Thanks for your interest in contributing! Read up on our guidelines for
26+
[contributing](https://github.com/driftyco/ionic/blob/master/.github/CONTRIBUTING.md)
27+
and then look through our issues with a [help wanted](https://github.com/driftyco/ionic/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
28+
label.
2029

21-
### Ionic 2 Examples
30+
### Examples
2231

23-
The [Ionic Conference App](https://github.com/driftyco/ionic-conference-app) is a full featured Ionic 2 app. It is the perfect starting point for learning and building your own app.
32+
The [Ionic Conference App](https://github.com/driftyco/ionic-conference-app) is a full featured Ionic app.
33+
It is the perfect starting point for learning and building your own app.
2434

2535
### Ionic 1.x
2636

27-
The source code for Ionic 1.x has been moved to [driftyco/ionic-v1](https://github.com/driftyco/ionic-v1). Please file issues and pull requests related to Ionic 1.x at that repo. 1.x issues and PRs on this repo will be closed.
37+
The source code for Ionic 1.x has been moved to [driftyco/ionic-v1](https://github.com/driftyco/ionic-v1).
38+
Please open any issues and pull requests related to Ionic 1.x on that repository.

0 commit comments

Comments
 (0)