asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: update readme (#2587)

Browse Source 
* docs: added features list

* docs: update readme
This commit is contained in:
Shahed Nasser
2022-11-10 17:52:03 +02:00
committed by GitHub
parent 7b96bb1f1a
commit 208809b635
3 changed files with 44 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@@ -37,51 +37,21 @@ An open source composable commerce engine built for developers.
## Getting Started
You can install Medusa by either following our [Quickstart guide](https://docs.medusajs.com/quickstart/quick-start) or the following steps:
1. **Install Medusa CLI**
```bash
npm install -g @medusajs/medusa-cli
```
2. **Create a new Medusa project**
```bash
medusa new my-medusa-store --seed
```
3. **Start your Medusa engine**
```bash
cd my-medusa-store
medusa develop
```
Follow our [quickstart guide](https://docs.medusajs.com/quickstart/quick-start) to learn how to set up a Medusa server.
### Requirements
- Node v14.0 or higher.
- SQLite or PostgreSQL (SQLite is only for getting started; PostgreSQL is recommended)
- Redis
You can check out [this documentation for details about setting up your environment](https://docs.medusajs.com/tutorial/set-up-your-development-environment).
You can check out [this documentation for more details about setting up your environment](https://docs.medusajs.com/tutorial/set-up-your-development-environment).
## What is Medusa?
## 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.
You can learn more about [Medusa’s architecture in our documentation](https://docs.medusajs.com/introduction).
You can learn more about [Medusa’s architecture in our documentation](https://docs.medusajs.com/introduction#architecture).
### Features
- **Orders, Exchanges, and Returns APIs:** Aside from the standard order management that comes with ecommerce platforms, Medusa also provides an easy and automated way to manage swaps, returns, and claims.
- **Products and Collections APIs:** Add products with extensive customization settings and sort them into collections.
- **Region API:** Configure and manage multiple regions and currencies all from one platform.
- **Plugin API:** Easily integrate fulfillment providers, payment providers, notification services, and many other custom tools and third-party services.
- ****PriceList and Promotions APIs:**** Advanced pricing for products with conditions based on the amount in the cart or promotions and discounts.
- **Tax API:** Advanced tax configurations specific to multiple regions, with the capability of specifying taxes for specific products.
See more of the [ecommerce features on our documentation](https://docs.medusajs.com/#features).
You can learn about all of the ecommerce features that Medusa provides [in our documentation](https://docs.medusajs.com/introduction#features).
## Roadmap
@@ -106,15 +76,15 @@ Write-ups for all features will be made available in [Github discussions](https
## Plugins
As a headless and extendible solution, Medusa allows you to integrate third-party services or add custom features to Medusa by installing Plugins.
Check out [our available plugins](https://github.com/medusajs/medusa/tree/master/packages) that you can install and use instantly on your Medusa server.
## Contributions
Medusa is all about the community. Therefore, we would love for you to help us build the most robust and powerful commerce engine on the market.
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.
Whether it is fixing bugs, improving our documentation, or simply spreading the word, please feel free to join in. Please check [our contribution guide](https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md) for further details about how to contribute.
## Upgrade Guides
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
@@ -127,10 +97,6 @@ Use these channels to be part of the community, ask for help while using Medusa,
- [Twitter](https://twitter.com/medusajs)
- [LinkedIn](https://www.linkedin.com/company/medusajs)
## Upgrade Guides
Follow our [upgrade guides](https://docs.medusajs.com/advanced/backend/upgrade-guides/) on the documentation to keep your Medusa project up-to-date.
## License
Licensed under the [MIT License](https://github.com/medusajs/medusa/blob/master/LICENSE)