diff --git a/.github/assets/logo.png b/.github/assets/logo.png new file mode 100644 index 0000000000..42c5f25bfa Binary files /dev/null and b/.github/assets/logo.png differ diff --git a/README.md b/README.md index d24b6ffb98..3320c15633 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,63 @@ -# Ionic Framework +

+ + Ionic + +

-[Ionic Framework](https://ionicframework.com/) is the open-source mobile app development framework that makes it easy to -build top quality native and progressive web apps with web technologies. +

+ Ionic +

-Ionic Framework is based on [Web Components](https://www.webcomponents.org/introduction) and comes with many significant performance, usability, and feature improvements over the past versions. +

+ Ionic is an open source app development toolkit for building modern, fast, top-quality cross-platform native and Progressive Web Apps from a single codebase with JavaScript and the Web. +

+

+ Ionic is based on Web Components, which enables significant performance, usability, and feature improvements alongside support for popular web frameworks like Angular, React, and Vue. -## Looking for the Ionic Framework v6 beta? +

-[Click here to get started!](https://github.com/ionic-team/ionic-framework/blob/next/BETA.md) +

+ + Ionic Framework is released under the MIT license. + + + PRs welcome! + + + Follow @IonicFramework + + + Official Ionic Discord + +

+ +

+ Quickstart + · + + Documentation + + · + Contribute + · + Blog +
+ Community: + Discord + · + Forums + · + Twitter +

### Packages -| Project | Package | Version | Links | -| ------- | ------- | ------- |:-----:| -| **Core** | [`@ionic/core`](https://www.npmjs.com/package/@ionic/core) | [![version](https://img.shields.io/npm/v/@ionic/core/latest.svg)](https://www.npmjs.com/package/@ionic/core) | [`README.md`](core/README.md) -| **Angular** | [`@ionic/angular`](https://www.npmjs.com/package/@ionic/angular) | [![version](https://img.shields.io/npm/v/@ionic/angular/latest.svg)](https://www.npmjs.com/package/@ionic/angular) | [`README.md`](angular/README.md) -| **Vue** | [`@ionic/vue`](https://www.npmjs.com/package/@ionic/vue) | [![version](https://img.shields.io/npm/v/@ionic/vue/latest.svg)](https://www.npmjs.com/package/@ionic/vue) | [`README.md`](packages/vue/README.md) -| **React** | [`@ionic/react`](https://www.npmjs.com/package/@ionic/react) | [![version](https://img.shields.io/npm/v/@ionic/react/latest.svg)](https://www.npmjs.com/package/@ionic/react) | [`README.md`](packages/react/README.md) +| Project | Package | Version | Downloads| Links | +| ------- | ------- | ------- | -------- |:-----:| +| **Core** | [`@ionic/core`](https://www.npmjs.com/package/@ionic/core) | [![version](https://img.shields.io/npm/v/@ionic/core/latest.svg)](https://www.npmjs.com/package/@ionic/core) | NPM Downloads | [`README.md`](core/README.md) +| **Angular** | [`@ionic/angular`](https://www.npmjs.com/package/@ionic/angular) | [![version](https://img.shields.io/npm/v/@ionic/angular/latest.svg)](https://www.npmjs.com/package/@ionic/angular) | NPM Downloads | [`README.md`](angular/README.md) +| **Vue** | [`@ionic/vue`](https://www.npmjs.com/package/@ionic/vue) | [![version](https://img.shields.io/npm/v/@ionic/vue/latest.svg)](https://www.npmjs.com/package/@ionic/vue) | NPM Downloads | [`README.md`](packages/vue/README.md) +| **React** | [`@ionic/react`](https://www.npmjs.com/package/@ionic/react) | [![version](https://img.shields.io/npm/v/@ionic/react/latest.svg)](https://www.npmjs.com/package/@ionic/react) | NPM Downloads |[`README.md`](packages/react/README.md) Looking for the `ionic-angular` package? Ionic 3 has been moved to the [`ionic-v3`](https://github.com/ionic-team/ionic-v3) repo. See [Earlier Versions](#earlier-versions). @@ -26,6 +67,18 @@ Start a new project by following our quick [Getting Started guide](https://ionic We would love to hear from you! If you have any feedback or run into issues using our framework, please file an [issue](https://github.com/ionic-team/ionic/issues/new) on this repository. +### Migration Guides + +Already have an Ionic app? These guides will help you migrate to the latest versions. + +* [Migrate from v5 to v6](https://ionicframework.com/docs/next/reference/migration#migrating-from-ionic-5x-to-ionic-6x) +* [Migrate from v4 to v5](https://ionicframework.com/docs/reference/migration#migrating-from-ionic-4x-to-ionic-5x) +* [Migrate from v3 to v4](https://ionicframework.com/docs/reference/migration#migrating-from-ionic-30-to-ionic-40) + +### Examples + +The [Ionic Conference App](https://github.com/ionic-team/ionic-conference-app) is a full featured Ionic app. +It is the perfect starting point for learning and building your own app. ### Contributing @@ -36,13 +89,6 @@ label. Please note that this project is released with a [Contributor Code of Conduct](https://github.com/ionic-team/ionic/blob/main/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. - -### Examples - -The [Ionic Conference App](https://github.com/ionic-team/ionic-conference-app) is a full featured Ionic app. -It is the perfect starting point for learning and building your own app. - - ### Future Goals As Ionic Framework components migrate to the web component standard, a goal of ours is to have Ionic Framework easily work within all of the popular frameworks.