docs: readme changes - Githubissues

vuestorefront / vue-storefront

Alokai is a Frontend as a Service solution that simplifies composable commerce. It connects all the technologies needed to build and deploy fast & scalable ecommerce frontends. It guides merchants to deliver exceptional customer experiences quickly and easily.

https://www.alokai.com

MIT License

10.59k stars 2.08k forks source link

docs: readme changes #6881

Closed skirianov closed 1 year ago

skirianov commented 1 year ago

New README changes according to Team Community remarks and discussion.

Description

Full redesign and rewrite of the previous README

Related Issue

Motivation and Context

Previous README was outdated and too generic

How Has This Been Tested?

N/A

Screenshots:

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[x] I have read the CONTRIBUTING document.

Changelog

[ ] I have updated the Changelog (V1) v2 and mentioned all breaking changes in the public API.
[ ] I have documented all new public APIs and made changes to existing docs mentioning the parts I've changed so they're up to date.

Tests

[ ] I have written test cases for my code
[ ] I have tested my Pull Request on production build and (to my knowledge) it works without any issues
[ ] I have added tests to cover my changes.
[ ] All new and existing tests passed.

I tested manually my code, and it works well with both:
[ ] Default Theme
[ ] Capybara Theme

Code standards

[ ] My code follows the code style of this project.
[ ] I have followed naming conventions

Docs

[ ] My change requires a change to the documentation.
[ ] I have updated the documentation accordingly.