Blame: README.md - ionic-team/ionic-framework

ionic-team / ionic-framework UNCLAIMED

A powerful cross-platform UI toolkit for building native-quality iOS, Android, and Progressive Web Apps with HTML, CSS, and JavaScript.

52427 0 0 TypeScript

Normal View History Raw

chore(README): update readme format (#24368) 2021-12-10 17:00:25 -05:00			`<p align="center">`
			`<a href="#">`
chore(README): update links from next to main (#24384) 2021-12-13 13:34:12 -05:00			`<img alt="Ionic" src="https://github.com/ionic-team/ionic-framework/blob/main/.github/assets/logo.png?raw=true" width="60" />`
chore(README): update readme format (#24368) 2021-12-10 17:00:25 -05:00			`</a>`
			`</p>`

			`<h1 align="center">`
			`Ionic`
			`</h1>`

			`<p align="center">`
			`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.`
			`</p>`
			`<p align="center">`
			`Ionic is based on <a href="https://www.webcomponents.org/introduction">Web Components</a>, which enables significant performance, usability, and feature improvements alongside support for popular web frameworks like <a href="https://angular.io/">Angular</a>, <a href="https://reactjs.com/">React</a>, and <a href="https://vuejs.org/">Vue</a>.`

			`</p>`

			`<p align="center">`
			`<a href="https://github.com/ionic-team/ionic-framework/blob/main/LICENSE">`
			`<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Ionic Framework is released under the MIT license." />`
			`</a>`
docs(readme): update broken links, repository name, clean up readme (#29508) 2024-05-15 17:26:27 -04:00			`<a href="https://github.com/ionic-team/ionic-framework/blob/main/docs/CONTRIBUTING.md">`
chore(README): update readme format (#24368) 2021-12-10 17:00:25 -05:00			`<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome!" />`
			`</a>`
			`<a href="https://twitter.com/Ionicframework">`
			`<img src="https://img.shields.io/twitter/follow/ionicframework.svg?label=Follow%20@IonicFramework" alt="Follow @IonicFramework">`
			`</a>`
			`<a href="https://ionic.link/discord">`
			`<img src="https://img.shields.io/discord/520266681499779082?color=7289DA&label=%23ionic&logo=discord&logoColor=white" alt="Official Ionic Discord" />`
			`</a>`
			`</p>`

			`<h2 align="center">`
chore(): fix link in readme (#26977) 2023-03-17 15:55:18 -04:00			`<a href="https://ionicframework.com/docs/intro/cli">Quickstart</a>`
chore(README): update readme format (#24368) 2021-12-10 17:00:25 -05:00			`<span> · </span>`
			`<a href="https://ionicframework.com/docs/">`
			`Documentation`
			`</a>`
			`<span> · </span>`
docs(readme): update broken links, repository name, clean up readme (#29508) 2024-05-15 17:26:27 -04:00			`<a href="https://github.com/ionic-team/ionic-framework/blob/main/docs/CONTRIBUTING.md">Contribute</a>`
chore(README): update readme format (#24368) 2021-12-10 17:00:25 -05:00			`<span> · </span>`
			`<a href="https://blog.ionicframework.com/">Blog</a>`
			`<br />`
chore(readme): update examples of conference app to include react conference app (#27013) 2023-03-23 14:46:57 -04:00			`Community:`
chore(README): update readme format (#24368) 2021-12-10 17:00:25 -05:00			`<a href="https://ionic.link/discord">Discord</a>`
			`<span> · </span>`
			`<a href="https://forum.ionicframework.com/">Forums</a>`
			`<span> · </span>`
			`<a href="https://twitter.com/Ionicframework">Twitter</a>`
			`</h2>`
docs(readme): add v4 readme 2017-07-06 16:11:52 -04:00
chore: extract v3 into its own repository (#16131) These should be the necessary changes to move v3 source code & issues to the new home for Ionic 3: https://github.com/ionic-team/ionic-v3 2018-10-29 15:10:29 -05:00			`### Packages`
docs(readme): add v4 readme 2017-07-06 16:11:52 -04:00
chore(README): update readme format (#24368) 2021-12-10 17:00:25 -05:00			`\| 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) \| <a href="https://www.npmjs.com/package/@ionic/core" target="_blank"><img src="https://img.shields.io/npm/dm/@ionic/core.svg" alt="NPM Downloads" /></a> \| [`README.md`](core/README.md)
chore(docs): fix broken angular link in README (#28039) <!-- Please do not submit updates to dependencies unless it fixes an issue. --> <!-- Please try to limit your pull request to one type (bugfix, feature, etc). Submit multiple pull requests if needed. --> ## What is the current behavior? <!-- Please describe the current behavior that you are modifying. --> angular link in README is broken ## What is the new behavior? <!-- Please describe the behavior or changes that are being added by this PR. --> angular link in README is fixed now. ## Does this introduce a breaking change? - [ ] Yes - [x] No <!-- If this introduces a breaking change, please describe the impact and migration path for existing applications below. --> ## Other information <!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. --> 2023-08-22 22:14:24 +08:00			\| 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) \| <a href="https://www.npmjs.com/package/@ionic/angular" target="_blank"><img src="https://img.shields.io/npm/dm/@ionic/angular.svg" alt="NPM Downloads" /></a> \| [`README.md`](packages/angular/README.md)
chore(README): update readme format (#24368) 2021-12-10 17:00:25 -05:00			\| 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) \| <a href="https://www.npmjs.com/package/@ionic/vue" target="_blank"><img src="https://img.shields.io/npm/dm/@ionic/vue.svg" alt="NPM Downloads" /></a> \| [`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) \| <a href="https://www.npmjs.com/package/@ionic/react" target="_blank"><img src="https://img.shields.io/npm/dm/@ionic/react.svg" alt="NPM Downloads" /></a> \|[`README.md`](packages/react/README.md)
docs(readme): add v4 readme 2017-07-06 16:11:52 -04:00
chore: extract v3 into its own repository (#16131) These should be the necessary changes to move v3 source code & issues to the new home for Ionic 3: https://github.com/ionic-team/ionic-v3 2018-10-29 15:10:29 -05:00			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).
docs(readme): add v4 readme 2017-07-06 16:11:52 -04:00
docs(readme): move breaking changes out, add more, remove duplicates 2017-07-21 12:15:12 -04:00			`### Getting Started`
docs(readme): add v4 readme 2017-07-06 16:11:52 -04:00
docs(readme): update broken links, repository name, clean up readme (#29508) 2024-05-15 17:26:27 -04:00			`Start a new project by following our [documentation](https://ionicframework.com/docs/).`
docs(readme): move breaking changes out, add more, remove duplicates 2017-07-21 12:15:12 -04:00			`We would love to hear from you! If you have any feedback or run into issues using our framework, please file`
docs(readme): update broken links, repository name, clean up readme (#29508) 2024-05-15 17:26:27 -04:00			`an [issue](https://github.com/ionic-team/ionic-framework/issues/new) on this repository.`
docs(readme): add v4 readme 2017-07-06 16:11:52 -04:00
chore(README): update readme format (#24368) 2021-12-10 17:00:25 -05:00			`### Migration Guides`

			`Already have an Ionic app? These guides will help you migrate to the latest versions.`

docs(readme): update broken links, repository name, clean up readme (#29508) 2024-05-15 17:26:27 -04:00			`* [Migrate from v7 to v8](https://ionicframework.com/docs/updating/8-0)`
chore(readme): update migration guides to correct links (#27072) 2023-03-31 10:34:26 -04:00			`* [Migrate from v6 to v7](https://ionicframework.com/docs/updating/7-0)`
			`* [Migrate from v5 to v6](https://ionicframework.com/docs/updating/6-0)`
			`* [Migrate from v4 to v5](https://ionicframework.com/docs/updating/5-0)`
			`* [Migrate from v3 to v4](https://ionicframework.com/docs/updating/4-0)`
chore(README): update readme format (#24368) 2021-12-10 17:00:25 -05:00
			`### Examples`

chore(readme): update examples of conference app to include react conference app (#27013) 2023-03-23 14:46:57 -04:00			`The Ionic Conference App is a full featured Ionic app. It is the perfect starting point for learning and building your own app.`

			`- [Angular Ionic Conference App](https://github.com/ionic-team/ionic-conference-app)`
			`- [React Ionic Conference App](https://github.com/ionic-team/ionic-react-conference-app)`
docs(readme): update broken links, repository name, clean up readme (#29508) 2024-05-15 17:26:27 -04:00			`- [Vue Ionic Conference App](https://github.com/ionic-team/ionic-vue-conference-app)`
docs(readme): add v4 readme 2017-07-06 16:11:52 -04:00
docs(readme): move breaking changes out, add more, remove duplicates 2017-07-21 12:15:12 -04:00			`### Contributing`
docs(readme): add v4 readme 2017-07-06 16:11:52 -04:00
docs(readme): move breaking changes out, add more, remove duplicates 2017-07-21 12:15:12 -04:00			`Thanks for your interest in contributing! Read up on our guidelines for`
docs(readme): update broken links, repository name, clean up readme (#29508) 2024-05-15 17:26:27 -04:00			`[contributing](https://github.com/ionic-team/ionic-framework/blob/main/docs/CONTRIBUTING.md)`
			`and then look through our issues with a [help wanted](https://github.com/ionic-team/ionic-framework/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)`
docs(readme): move breaking changes out, add more, remove duplicates 2017-07-21 12:15:12 -04:00			`label.`
docs(readme): add v4 readme 2017-07-06 16:11:52 -04:00
docs(readme): update broken links, repository name, clean up readme (#29508) 2024-05-15 17:26:27 -04:00			`Please note that this project is released with a [Contributor Code of Conduct](https://github.com/ionic-team/ionic-framework/blob/main/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.`
docs(readme): add v4 readme 2017-07-06 16:11:52 -04:00
chore: extract v3 into its own repository (#16131) These should be the necessary changes to move v3 source code & issues to the new home for Ionic 3: https://github.com/ionic-team/ionic-v3 2018-10-29 15:10:29 -05:00			`### Earlier Versions`
docs(readme): add v4 readme 2017-07-06 16:11:52 -04:00
chore: extract v3 into its own repository (#16131) These should be the necessary changes to move v3 source code & issues to the new home for Ionic 3: https://github.com/ionic-team/ionic-v3 2018-10-29 15:10:29 -05:00			`The source code for earlier versions of the Ionic Framework may exist in other repositories. Please open issues and pull requests in their respective repositories.`
docs(readme): add v4 readme 2017-07-06 16:11:52 -04:00
chore: extract v3 into its own repository (#16131) These should be the necessary changes to move v3 source code & issues to the new home for Ionic 3: https://github.com/ionic-team/ionic-v3 2018-10-29 15:10:29 -05:00			* Ionic 2/3: Moved to [`ionic-team/ionic-v3`](https://github.com/ionic-team/ionic-v3)
			* Ionic 1: Moved to [`ionic-team/ionic-v1`](https://github.com/ionic-team/ionic-v1)