diff --git a/README.md b/README.md index ae21cfa652..0aa189564d 100644 --- a/README.md +++ b/README.md @@ -25,14 +25,14 @@ ## Getting Started -Alright, for you to get started if you are looking for making Element Plus better you should keep reading. -For developers that uses Element Plus to develop your website you should go ahead visit [Getting Started](https://element-plus.org/). +Alright, if you're looking to make Element Plus better, keep reading. +For developers using Element Plus to build websites, please visit [Getting Started](https://element-plus.org/). - 中国大陆[加速镜像站点](https://cn.element-plus.org/zh-CN/) -## Breaking change list +## Breaking Change List -The first stable release of Element Plus suitable for use in production was released on February 07, 2022. The APIs is stable right now, and here's also a full list about how to get upgraded from [Element UI](https://element.eleme.io) to Element Plus. +The first stable release of Element Plus, suitable for production use, was released on February 7, 2022. The API is stable now, and here's a full list on how to upgrade from [Element UI](https://element.eleme.io) to Element Plus. You can find the breaking change list here: [Breaking Change List](https://github.com/element-plus/element-plus/discussions/5658). @@ -40,24 +40,24 @@ You can find the breaking change list here: [Breaking Change List](https://githu We have made a migration tool for you to migrate your project from [Element UI](https://element.eleme.io) to Element Plus. -You can find the [gogo code migration tool](https://github.com/thx/gogocode/tree/main/packages/gogocode-plugin-element) here. +You can find the [gogocode migration tool](https://github.com/thx/gogocode/tree/main/packages/gogocode-plugin-element) here. We have tested this on [Vue Element Admin](https://github.com/PanJiaChen/vue-element-admin). You can find the transpiled code [here](https://github.com/gogocodeio/vue-element-admin). ### Playground -You can also try Element Plus out with the components built-in playground. +You can also try out Element Plus with its built-in component playground. #### Try it with our built-in playground [Playground](https://element-plus.run/) -#### Try it with code sandbox +#### Try it with CodeSandbox [](https://codesandbox.io/p/github/element-plus/element-plus-demo/main)
- Special thanks to the generous sponsorship by: + Special thanks to our generous sponsors:
@@ -108,15 +108,15 @@ You can also try Element Plus out with the components built-in playground. ## Translations -Element Plus is translated to multiple languages, you can click the badge to help up update the translation or apply to become -a proofreader [](https://crowdin.com/project/element-plus) +Element Plus has been translated into multiple languages. You can click the badge to help us update the translations or apply to become +a proofreader. [](https://crowdin.com/project/element-plus) -For now we are only showing English and Chinese for resource reasons, but we are looking forward to translate it into more languages, please go to the link -above and leave a message if you want to help translating Element Plus into your desired language. +For now, we are only providing English and Chinese versions due to limited resources, but we are looking forward to translating it into more languages. Please visit the link +above and leave a message if you would like to help translate Element Plus into your preferred language. -### How to help translating +### How to help translate -See how to help translating in [Translating Element Plus](https://element-plus.org/en-US/guide/translation.html). +See how to help translate in [Translating Element Plus](https://element-plus.org/en-US/guide/translation.html). ## Stay tuned :eyes: @@ -131,10 +131,10 @@ where you'll find the same information listed below. ## I would like to become a part of the development team! -Welcome :star_struck:! We are looking for talented developers to join us and making Element Plus better! If you care to join the development team, please -reach out to us, you are more than welcomed to join us! :heart: +Welcome :star_struck:! We are looking for talented developers to join us and make Element Plus better! If you're interested in joining the development team, please +reach out to us -- you're more than welcome to join us! :heart: -We are now lacking of experts of `Testing`, `GitHub Actions`, `PM`, if you do feel like you can and willing to help us, please do reach out to us. :pray: +We are now looking for experts in `Testing`, `GitHub Actions` and `PM`. If you feel like you can and are willing to help, please don't hesitate to reach out to us. :pray: ## Contributors