chore: Update README (#3643)
* chore: Update README * Address feedback * Update README.md * Update README.md Co-authored-by: Shahed Nasser <shahednasser@gmail.com> --------- Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
committed by
GitHub
parent
45fd0fb639
commit
36337ef3b3
48
README.md
48
README.md
@@ -1,7 +1,8 @@
|
||||
<p align="center">
|
||||
<a href="https://www.medusajs.com">
|
||||
<img alt="Medusa" src="https://user-images.githubusercontent.com/7554214/153162406-bf8fd16f-aa98-4604-b87b-e13ab4baf604.png" width="100" />
|
||||
<img alt="Medusa" src="https://user-images.githubusercontent.com/59018053/228887024-f13c2620-2b21-4ed7-b712-38b5ec89cad9.svg" width="100" />
|
||||
</a>
|
||||
|
||||
</p>
|
||||
<h1 align="center">
|
||||
Medusa
|
||||
@@ -9,12 +10,11 @@
|
||||
|
||||
<h4 align="center">
|
||||
<a href="https://docs.medusajs.com">Documentation</a> |
|
||||
<a href="https://demo.medusajs.com/">Medusa Admin Demo</a> |
|
||||
<a href="https://www.medusajs.com">Website</a>
|
||||
</h4>
|
||||
|
||||
<p align="center">
|
||||
An open source composable commerce engine built for developers.
|
||||
Building blocks for digital commerce
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="https://github.com/medusajs/medusa/blob/master/LICENSE">
|
||||
@@ -37,49 +37,39 @@ An open source composable commerce engine built for developers.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Follow our [quickstart guide](https://docs.medusajs.com/quickstart/quick-start) to learn how to set up a Medusa server.
|
||||
Visit the [Quickstart Guide](https://docs.medusajs.com/create-medusa-app) to set up a server.
|
||||
|
||||
### Requirements
|
||||
|
||||
You can check out [this documentation for details about setting up your environment](https://docs.medusajs.com/tutorial/set-up-your-development-environment).
|
||||
Visit the [Docs](https://docs.medusajs.com/development/backend/prepare-environment) to learn more about our system requirements.
|
||||
|
||||
## What is Medusa
|
||||
|
||||
Medusa is an open source composable commerce engine built with Node.js. Medusa enables developers to build scalable and sophisticated commerce setups with low effort and great developer experience.
|
||||
Medusa is a set of commerce modules and tools that allow you to build rich, reliable, and performant commerce applications without reinventing core commerce logic. The modules can be customized and used to build advanced ecommerce stores, marketplaces, or any product that needs foundational commerce primitives. All modules are open-source and freely available on npm.
|
||||
|
||||
You can learn more about [Medusa’s architecture in our documentation](https://docs.medusajs.com/introduction#architecture).
|
||||
Learn more about [Medusa’s architecture](https://docs.medusajs.com/development/fundamentals/architecture-overview) and [commerce modules](https://docs.medusajs.com/modules/overview) in the Docs.
|
||||
|
||||
### Features
|
||||
## Roadmap, Upgrades & Plugins
|
||||
|
||||
You can learn about all of the ecommerce features that Medusa provides [in our documentation](https://docs.medusajs.com/introduction#features).
|
||||
You can view the planned, started and completed features in the [Roadmap discussion](https://github.com/medusajs/medusa/discussions/categories/roadmap).
|
||||
|
||||
## Roadmap
|
||||
Follow the [Upgrade Guides](https://docs.medusajs.com/upgrade-guides/) to keep your Medusa project up-to-date.
|
||||
|
||||
You can view our roadmap with features that are planned, started, and completed on the [Roadmap discussion](https://github.com/medusajs/medusa/discussions/categories/roadmap) category.
|
||||
Check out all [available Medusa plugins](https://medusajs.com/plugins/).
|
||||
|
||||
## Plugins
|
||||
## Community & Contributions
|
||||
|
||||
Check out [our available plugins](https://github.com/medusajs/medusa/tree/master/packages) that you can install and use instantly on your Medusa server.
|
||||
The community and core team are available in [GitHub Discussions](https://github.com/medusajs/medusa/discussions), where you can ask for support, discuss roadmap, and share ideas.
|
||||
|
||||
## Contributions
|
||||
Our [Contribution Guide](https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md) describes how to contribute to the codebase and Docs.
|
||||
|
||||
Please check [our contribution guide](https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md) for details about how to contribute to both our codebase and our documentation.
|
||||
Join our [Discord server](https://discord.com/invite/medusajs) to meet other community members.
|
||||
|
||||
## Upgrade Guides
|
||||
## Other channels
|
||||
|
||||
Follow our [upgrade guides](https://docs.medusajs.com/advanced/backend/upgrade-guides/) on the documentation to keep your Medusa project up-to-date.
|
||||
|
||||
## Community & Support
|
||||
|
||||
Use these channels to be part of the community, ask for help while using Medusa, or just learn more about Medusa:
|
||||
|
||||
- [Discord](https://discord.gg/medusajs): This is the main channel to join the community. You can ask for help, showcase your work with Medusa, and stay up to date with everything Medusa.
|
||||
- [GitHub Issues](https://github.com/medusajs/medusa/issues): for sending in any issues you face or bugs you find while using Medusa.
|
||||
- [GitHub Discussions](https://github.com/medusajs/medusa/discussions): for joining discussions and submitting your ideas.
|
||||
- [Medusa Blog](https://medusajs.com/blog/): find diverse tutorials and company news.
|
||||
- [GitHub Issues](https://github.com/medusajs/medusa/issues)
|
||||
- [Twitter](https://twitter.com/medusajs)
|
||||
- [LinkedIn](https://www.linkedin.com/company/medusajs)
|
||||
- [Medusa Blog](https://medusajs.com/blog/)
|
||||
|
||||
## License
|
||||
|
||||
Licensed under the [MIT License](https://github.com/medusajs/medusa/blob/master/LICENSE)
|
||||
Licensed under the [MIT License](https://github.com/medusajs/medusa/blob/master/LICENSE).
|
||||
|
||||
Reference in New Issue
Block a user