docs: README enhancements for cms-base package (#177)

.changeset/giant-cooks-judge.md

@@ -0,0 +1,5 @@
+---
+"@shopware-pwa/cms-base": patch
+---
+
+README enhancements

packages/cms-base/README.md

@@ -1,10 +1,79 @@
 # shopware/frontends - cms-base
 
-Welcome to `@shopware-pwa/cms-base` package.
+[![](https://img.shields.io/npm/v/@shopware-pwa/cms-base?color=blue&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTIiIGhlaWdodD0iMTIiIHZpZXdCb3g9IjAgMCA0ODggNTUzIiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8cGF0aCBkPSJNNDM5LjA0MSAxMjkuNTkzTDI1OC43NjkgMzEuMzA3NkMyNDQuOTE1IDIzLjc1NDEgMjI4LjExNiAyNC4wMDkzIDIxNC40OTcgMzEuOTgwMkw0Ny4yNjkgMTI5Ljg1OEMzMy40NzYzIDEzNy45MzEgMjUgMTUyLjcxMyAyNSAxNjguNjk1VjM4OC40NjZDMjUgNDA0LjczMiAzMy43Nzg1IDQxOS43MzIgNDcuOTYwMiA0MjcuNjk5TDIxNS4xNzggNTIxLjYzNkMyMjguNDUxIDUyOS4wOTIgMjQ0LjU5MyA1MjkuMzMyIDI1OC4wODIgNTIyLjI3NEw0MzguMzY0IDQyNy45MzRDNDUzLjIwMSA0MjAuMTcgNDYyLjUgNDA0LjgwOSA0NjIuNSAzODguMDYzVjE2OS4xMDJDNDYyLjUgMTUyLjYzMiA0NTMuNTAyIDEzNy40NzcgNDM5LjA0MSAxMjkuNTkzWiIgc3Ryb2tlPSJ1cmwoI3BhaW50MF9saW5lYXJfMTUzXzY5MjY1KSIgc3Ryb2tlLXdpZHRoPSI1MCIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCIvPgo8ZGVmcz4KPGxpbmVhckdyYWRpZW50IGlkPSJwYWludDBfbGluZWFyXzE1M182OTI2NSIgeDE9Ii0xNi4yOTg5IiB5MT0iMTY1LjM0OSIgeDI9IjI3Ni40MTIiIHkyPSItODkuMzIzNCIgZ3JhZGllbnRVbml0cz0idXNlclNwYWNlT25Vc2UiPgo8c3RvcCBzdG9wLWNvbG9yPSIjMDA4NUZGIi8+CjxzdG9wIG9mZnNldD0iMSIgc3RvcC1jb2xvcj0iI0MwRTJGNSIvPgo8L2xpbmVhckdyYWRpZW50Pgo8L2RlZnM+Cjwvc3ZnPg==)](https://npmjs.com/package/@shopware-pwa/cms-base)
+[![](https://img.shields.io/github/package-json/v/shopware/frontends?color=blue&filename=packages%2Fcms-base%2Fpackage.json&label=cms-base%40monorepo&logo=github)](https://github.com/shopware/frontends/tree/main/packages/cms-base)
+![](https://img.shields.io/github/license/shopware/frontends?color=blue)
+[![](https://img.shields.io/github/issues/shopware/frontends/cms-base?label=cms-base%20issues&logo=github)](https://github.com/shopware/frontends/issues?q=is%3Aopen+is%3Aissue+label%3Acms-base)
 
-For getting started documentation visit [https://frontends.shopware.com/](https://frontends.shopware.com/)
 
-Documentation specific for this package: [cms-base](https://frontends.shopware.com/packages/cms-base.html)
+Nuxt [module](https://nuxt.com/docs/guide/going-further/modules) that provides an implementation of all CMS components in Shopware [based on utility-classes](https://frontends.shopware.com/framework/styling.html) using unocss/Tailwind.css syntax. 
+
+It is useful for projects that want to use the CMS components but design their own layout.
+
+## Features
+
+- Vue components for [Shopping Experiences](https://www.shopware.com/en/products/shopping-experiences/) CMS
+- CMS sections, blocks and elements styled using [Tailwind CSS](https://tailwindcss.com/) classes
+- 🚀 Empowered by [@shopware-pwa/composables-next](https://www.npmjs.com/package/@shopware-pwa/composables-next)
+
+
+## Setup
+
+Install npm package:
+
+```bash
+# Using pnpm
+pnpm add -D @shopware-pwa/cms-base
+
+# Using yarn
+yarn add --dev @shopware-pwa/cms-base
+
+# Using npm
+npm i @shopware-pwa/cms-base --save-dev
+```
+
+Then, register the module by editing `nuxt.config.js` or (`.ts`) file:
+
+```js
+/* nuxt.config.ts */
+
+export default defineNuxtConfig({
+  /* ... */
++ modules: [/* ... */, "@shopware-pwa/cms-base"],
+});
+```
+
+## Basic usage
+
+Since all CMS components are registered in your Nuxt application, you can now start using them in your template (no imports needed):
+
+```js
+/* Vue component */
+
+// response object can be a Product|Category|Landing Page response from Shopware 6 store-api containing a layout (cmsPage object) built using  Shopping Experiences
+<template>
+    <CmsPage v-if="response.cmsPage" :content="response.cmsPage"/>
+</template>
+```
+
+> You can use default styling by installing/importing Tailwind CSS stylesheet in your project.
+
+See a [short guide](https://frontends.shopware.com/getting-started/cms/content-pages.html#use-the-cms-base-package) how to use `cms-base` package in your project based on Nuxt v3.
+
+
+## TypeScript support
+
+All components are fully typed with TypeScript. 
+
+No additional packages needed to be installed.
+
+
+## Links
+
+* [📘 Documentation](https://frontends.shopware.com)
+
+* [👥 Community](https://shopwarecommunity.slack.com ()
+) (`#shopware-frontends` & `#shopware-pwa` channel)
 
 <!-- AUTO GENERATED CHANGELOG -->