From d79ddb07febae19b02982a83ea24520453b502fe Mon Sep 17 00:00:00 2001 From: B Date: Mon, 26 Oct 2020 23:38:06 -0300 Subject: [PATCH] Update README.md --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a586199d2..6f1330d9c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,32 @@ # Next.js Commerce +The all-in-one starter kit for high-performance ecommerce sites. With a few clicks, Next.js developers can clone, deploy, and fully customize it. +Start right now at nextjs.org/commerce. -## Features +Demo live at: https://commerce-demo.vercel.app/ -## Todo +This project is currently under development. + +## Why +Ecommerce is one of the most important uses of the web and together we can raise the standard for ecommerce sites. + +## Goals and Features +- Performant by default +- SEO Ready +- Internationalization +- Responsive +- UI Components +- Theming +- Standarized Data Hooks +- Integrations - Integrate seamlessly with the most common ecommerce platforms. ## Contribute +Our Commitment to Open Source can be found [here](https://vercel.com/oss). + +1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device. +2. Create a new branch `git checkout -b MY_BRANCH_NAME` +3. Install yarn: `npm install -g yarn` +4. Install the dependencies: `yarn` +5. Run `yarn dev` to build and watch for code changes +7. The development branch is `development` (this is the branch pull requests should be made against). +On a release, the relevant parts of the changes in the `staging` branch are rebased into `master`. +