Merge pull request #293 from wpmudev/update-packages-readmes

README files updates
wpmudev · May 22, 2024 · 3af687e · 3af687e
2 parents 89f38cd + d9b2642
commit 3af687e
Show file tree

Hide file tree

Showing 33 changed files with 47 additions and 60 deletions.
diff --git a/packages/assets/css/README.md b/packages/assets/css/README.md
@@ -1,5 +1,4 @@
 [![npm](https://img.shields.io/npm/v/@wpmudev/sui-css?color=blue&style=for-the-badge)](https://www.npmjs.com/package/@wpmudev/sui-css)
-[![GitHub package.json version (subfolder of monorepo)](https://img.shields.io/github/package-json/v/wpmudev/sui-css?color=orange&filename=packages%2Flayout%2Fpackage.json&label=core&style=for-the-badge)](https://github.com/wpmudev/sui-css/)
 [![License: GPLv3](https://img.shields.io/badge/License-GPL%20v3-blue.svg?color=green&style=for-the-badge)](http://www.gnu.org/licenses/gpl-3.0)
 
 # **Shared UI CSS Framework**
@@ -22,6 +21,6 @@ npm install @wpmudev/sui-css --save-dev
 
 Please, read through our common guidelines before starting to contribute on any of our projects:
 
--   [General Guidelines](https://github.com/wpmudev/sui-docs/guidelines.md)
--   [Contributions Guidelines](https://github.com/wpmudev/sui-docs/contributions.md)
--   [Release Guidelines](https://github.com/wpmudev/sui-docs/release.md)
+-   [General Guidelines](https://github.com/wpmudev/sui-react/blob/update-packages-readmes/README.md)
+-   [Contributions Guidelines](https://github.com/wpmudev/sui-react/blob/development/CONTRIBUTION.md)
+-   [Release Guidelines](https://github.com/wpmudev/sui-react/blob/development/RELEASING.md)
diff --git a/packages/assets/css/package.json b/packages/assets/css/package.json
@@ -55,8 +55,7 @@
     "publish:test": "npm run prepare && npm version prerelease --git-tag-version=false && npm pack",
     "publish:patch": "npm run prepare && npm version patch -m \"📦️ SUI CSS Framework %s\" && npm publish",
     "publish:minor": "npm run prepare && npm version minor -m \"📦️ SUI CSS Framework %s\" && npm publish",
-    "publish:major": "npm run prepare && npm version major -m \"📦️ SUI CSS Framework %s\" && npm publish",
-    "build:readme": "readme generate --input ../../../blueprint.md"
+    "publish:major": "npm run prepare && npm version major -m \"📦️ SUI CSS Framework %s\" && npm publish"
   },
   "bugs": {
     "url": "https://github.com/wpmudev/sui-css"

diff --git a/packages/assets/css/src/scss/_utils/_tokens.scss b/packages/assets/css/src/scss/_utils/_tokens.scss
@@ -1,6 +1,6 @@
 
 // Do not edit directly
-// Generated on Mon, 20 May 2024 06:15:23 GMT
+// Generated on Tue, 21 May 2024 12:39:26 GMT
 
 $accordion-border-radius-sm: 10px;
 $advanced-banner-background: linear-gradient(90deg, #222 0%, #383323 48.96%, #514524 100%);

diff --git a/packages/assets/icons/README.md b/packages/assets/icons/README.md
@@ -65,18 +65,14 @@ There are many ways/formats to use the Shared UI Icons Package. The fastest and
 <span class="suicons suicons--plugin-smartcrawl"></span>
 ```
 
-## Bugs, Ideas, Pull Requests
+## Bugs, Ideas, Pull Requests, New Icons Request 
 
-If you have any ideas or found bugs, please send me Pull Requests or let me know with [GitHub Issues](https://github.com/wpmudev/sui-icons/issues).
+If you have any ideas, found bugs, or need a new icon, please send me Pull Requests or let me know with [GitHub Issues](https://github.com/wpmudev/sui-react/issues).
+
+We can usually add an icon and release a new version on the same day if there is a hurry. However, remember that if there's a similar icon already available, we suggest you use it instead unless you request a design update.
 
 ## License
 
 ### Can I use the SUI Icons Pack in my projects?
 
 We created the **WPMU DEV Design System** to build plugins and products for [WPMU DEV](https://wpmudev.com/), not on products outside the company. Please visit the terms of use for full license details.
-
-### Need a new icon?
-
-New icons need to be added to **SUI Icons Pack** first. Please, visit the [Support](https://wpmudev.github.io/sui-docs/?path=/story/sui-support--page) page for more information on how to request it.
-
-We can usually add an icon and release a new version on the same day if there is a hurry. However, remember that if there's a similar icon already available, we suggest you use it instead unless you request a design update.
diff --git a/packages/assets/icons/package.json b/packages/assets/icons/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@wpmudev/sui-icons",
-  "description": "SUI Icons Pack, the WPMU DEV Products icons font.",
+  "description": "SUI Icons Pack, the WPMU DEV Products icons package.",
   "version": "0.0.1",
   "license": "GPL-2.0",
   "keywords": [
@@ -15,11 +15,12 @@
   ],
   "author": "WPMU DEV (https://wpmudev.com)",
   "contributors": [
-        {
+    {
       "name": "Govind Kumar",
       "email": "[email protected]",
       "url": "https://govind.js.org/"
-    },{
+    },
+    {
       "name": "Leighton Sapir",
       "email": "[email protected]",
       "url": "https://iamleigh.com"
@@ -50,8 +51,7 @@
     "publish:test": "npm run prepare && npm version prerelease --git-tag-version=false && npm pack",
     "publish:patch": "npm run prepare && npm version patch -m \"🚀 Publish Icons Pack %s\" && npm publish",
     "publish:minor": "npm run prepare && npm version minor -m \"🚀 Publish Icons Pack %s\" && npm publish",
-    "publish:major": "npm run prepare && npm version major -m \"🚀 Publish Icons Pack %s\" && npm publish",
-    "build:readme": "readme generate --input ../../../blueprint.md"
+    "publish:major": "npm run prepare && npm version major -m \"🚀 Publish Icons Pack %s\" && npm publish"
   },
   "bugs": {
     "url": "https://incsub.atlassian.net/browse/SUI"

diff --git a/packages/common/advanced/README.md b/packages/common/advanced/README.md
@@ -1,7 +1,7 @@
 <!-- ⚠️ This README has been generated from the file(s) "../../../blueprint.md" ⚠️--><h1 align="center">@wpmudev/sui-advanced</h1>
 
 <div style="text-align: center;">
-<img src="https://img.shields.io/badge/Version-0.0.1-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
+<img src="https://img.shields.io/badge/Version-0.0.2-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
 </div>
 <h2> Description </h2> WPMU DEV Shared UI React sub-package for advanced elements
 

diff --git a/packages/docs/README.md b/packages/docs/README.md
@@ -1,11 +1,3 @@
 # `@wpmudev/sui-docs`
 
-> TODO: description
-
-## Usage
-
-```
-const storybook = require('@wpmudev/sui-docs');
-
-// TODO: DEMONSTRATE API
-```
+This package outlines the documentation for all the packages available in SUI library through storybook 
diff --git a/packages/react/README.md b/packages/react/README.md
@@ -1,7 +1,7 @@
 <!-- ⚠️ This README has been generated from the file(s) "../../blueprint.md" ⚠️--><h1 align="center">@wpmudev/sui-react</h1>
 
 <div style="text-align: center;">
-<img src="https://img.shields.io/badge/Version-0.0.1-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
+<img src="https://img.shields.io/badge/Version-0.0.10-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
 </div>
 <h2> Description </h2> It provides all the ui components for available for sui react
 

diff --git a/packages/ui/avatar/README.md b/packages/ui/avatar/README.md
@@ -3,7 +3,7 @@
 <div style="text-align: center;">
 <img src="https://img.shields.io/badge/Version-0.0.1-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
 </div>
-<h2> Description </h2> An avatar is a thumbnail that represents a user or organization on the SUI platform.
+<h2> Description </h2> An avatar is a thumbnail that represents a user or an organization.
 
 
 [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#license)

diff --git a/packages/ui/avatar/package.json b/packages/ui/avatar/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@wpmudev/sui-avatar",
   "version": "0.0.1",
-  "description": "An avatar is a thumbnail that represents a user or organization on the SUI platform.",
+  "description": "An avatar is a thumbnail that represents a user or an organization.",
   "keywords": [],
   "author": "WPMU DEV (https://wpmudev.com)",
   "contributors": [

diff --git a/packages/ui/box/README.md b/packages/ui/box/README.md
@@ -3,7 +3,7 @@
 <div style="text-align: center;">
 <img src="https://img.shields.io/badge/Version-0.0.1-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
 </div>
-<h2> Description </h2> WPMU DEV Shared UI React Box Component
+<h2> Description </h2> Box is a component utilized for presenting settings arranged in a two-column layout.
 
 
 [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#license)

diff --git a/packages/ui/box/package.json b/packages/ui/box/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@wpmudev/sui-box",
   "version": "0.0.1",
-  "description": "WPMU DEV Shared UI React Box Component",
+  "description": "Box is a component utilized for presenting settings arranged in a two-column layout.",
   "keywords": [],
   "author": "WPMU DEV (https://wpmudev.com)",
   "contributors": [

diff --git a/packages/ui/box/stories/box.mdx b/packages/ui/box/stories/box.mdx
@@ -7,7 +7,7 @@ import TabCode from "./tabs/TabCode.mdx"
 <Unstyled>
 	<Page.Tabs
 		title="Box"
-		subtitle=""
+		subtitle="Box is a component utilized for presenting settings arranged in a two-column layout."
     status="ready"
 	>
 			<div id="code" label="Code">

diff --git a/packages/ui/builder/README.md b/packages/ui/builder/README.md
@@ -3,7 +3,7 @@
 <div style="text-align: center;">
 <img src="https://img.shields.io/badge/Version-0.0.1-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
 </div>
-<h2> Description </h2> SUI builder is a drag and drop interface that allows to create or customize content layouts and arrangements by dragging and dropping various components into a canvas.
+<h2> Description </h2> Builder is a drag and drop interface that allows to create or customize content layouts and arrangements by dragging and dropping various components into a canvas.
 
 
 [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#license)

diff --git a/packages/ui/builder/package.json b/packages/ui/builder/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@wpmudev/sui-builder",
   "version": "0.0.1",
-  "description": "SUI builder is a drag and drop interface that allows to create or customize content layouts and arrangements by dragging and dropping various components into a canvas.",
+  "description": "Builder is a drag and drop interface that allows to create or customize content layouts and arrangements by dragging and dropping various components into a canvas.",
   "keywords": [],
   "author": "WPMU DEV (https://wpmudev.com)",
   "contributors": [

diff --git a/packages/ui/button/README.md b/packages/ui/button/README.md
@@ -3,7 +3,7 @@
 <div style="text-align: center;">
 <img src="https://img.shields.io/badge/Version-0.0.1-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
 </div>
-<h2> Description </h2> Buttons serve as a means to perform various interface actions, spanning from saving settings to initiating a modal. They offer diverse variations tailored to specific design requirements, enhancing the overall user experience.
+<h2> Description </h2> Buttons serve as a means to perform various interface actions, spanning from saving settings to initiating a modal. They offer diverse variations tailored to specific design requirements
 
 
 [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#license)

diff --git a/packages/ui/button/package.json b/packages/ui/button/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@wpmudev/sui-button",
   "version": "0.0.1",
-  "description": "Buttons serve as a means to perform various interface actions, spanning from saving settings to initiating a modal. They offer diverse variations tailored to specific design requirements, enhancing the overall user experience.",
+  "description": "Buttons serve as a means to perform various interface actions, spanning from saving settings to initiating a modal. They offer diverse variations tailored to specific design requirements",
   "keywords": [],
   "author": "WPMU DEV (https://wpmudev.com)",
   "contributors": [

diff --git a/packages/ui/code-snippet/README.md b/packages/ui/code-snippet/README.md
@@ -3,7 +3,7 @@
 <div style="text-align: center;">
 <img src="https://img.shields.io/badge/Version-0.0.1-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
 </div>
-<h2> Description </h2> Code Snippet is a block that allows for the display of codes.
+<h2> Description </h2> Code Snippet is a dedicated block designed to showcase code segments in a clear, formatted manner.
 
 
 [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#license)

diff --git a/packages/ui/code-snippet/package.json b/packages/ui/code-snippet/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@wpmudev/sui-code-snippet",
   "version": "0.0.1",
-  "description": "Code Snippet is a block that allows for the display of codes.",
+  "description": "Code Snippet is a dedicated block designed to showcase code segments in a clear, formatted manner.",
   "keywords": [],
   "author": "WPMU DEV (https://wpmudev.com)",
   "contributors": [

diff --git a/packages/ui/color-picker/README.md b/packages/ui/color-picker/README.md
@@ -1,7 +1,7 @@
 <!-- ⚠️ This README has been generated from the file(s) "../../../blueprint.md" ⚠️--><h1 align="center">@wpmudev/sui-color-picker</h1>
 
 <div style="text-align: center;">
-<img src="https://img.shields.io/badge/Version-0.0.1-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
+<img src="https://img.shields.io/badge/Version-0.0.2-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
 </div>
 <h2> Description </h2> The Color Picker Component enables users to select and apply colors in a consistent and efficient manner.
 

diff --git a/packages/ui/drawer/README.md b/packages/ui/drawer/README.md
@@ -1,9 +1,9 @@
-<!-- ⚠️ This README has been generated from the file(s) "../../../blueprint.md" ⚠️--><h1 align="center">@wpmudev/sui-sidebar</h1>
+<!-- ⚠️ This README has been generated from the file(s) "../../../blueprint.md" ⚠️--><h1 align="center">@wpmudev/sui-drawer</h1>
 
 <div style="text-align: center;">
 <img src="https://img.shields.io/badge/Version-0.0.1-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
 </div>
-<h2> Description </h2> A Sidebar is a group of navigation, typically a vertical column positioned on one side of the main content area.
+<h2> Description </h2> Drawer is used to display additional content or navigation options without taking up the entire screen.
 
 
 [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#license)

diff --git a/packages/ui/field-list/README.md b/packages/ui/field-list/README.md
@@ -3,7 +3,7 @@
 <div style="text-align: center;">
 <img src="https://img.shields.io/badge/Version-0.0.1-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
 </div>
-<h2> Description </h2> This component is to display the list of features to enable or disable.
+<h2> Description </h2> Field list is a component that allows you to display a list of features to enable or disable.
 
 
 [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#license)

diff --git a/packages/ui/field-list/package.json b/packages/ui/field-list/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@wpmudev/sui-field-list",
   "version": "0.0.1",
-  "description": "This component is to display the list of features to enable or disable.",
+  "description": "Field list is a component that allows you to display a list of features to enable or disable.",
   "keywords": [],
   "author": "WPMU DEV (https://wpmudev.com)",
   "contributors": [

diff --git a/packages/ui/form-field/README.md b/packages/ui/form-field/README.md
@@ -3,7 +3,7 @@
 <div style="text-align: center;">
 <img src="https://img.shields.io/badge/Version-0.0.1-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
 </div>
-<h2> Description </h2> WPMU DEV Shared UI React Form Field Component
+<h2> Description </h2> Form field is a set of elements that is use to collect data from users.
 
 
 [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#license)

diff --git a/packages/ui/form-field/package.json b/packages/ui/form-field/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@wpmudev/sui-form-field",
   "version": "0.0.1",
-  "description": "WPMU DEV Shared UI React Form Field Component",
+  "description": "Form field is a set of elements that is use to collect data from users.",
   "keywords": [],
   "author": "WPMU DEV (https://wpmudev.com)",
   "contributors": [

diff --git a/packages/ui/grid/README.md b/packages/ui/grid/README.md
@@ -3,7 +3,7 @@
 <div style="text-align: center;">
 <img src="https://img.shields.io/badge/Version-0.0.1-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
 </div>
-<h2> Description </h2> WPMU DEV Shared UI React Grid Elements
+<h2> Description </h2> The Grid is composed of two fundamental components: Row and Column. It empowers you to create layouts and align content with precision on your web page
 
 
 [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#license)

diff --git a/packages/ui/grid/package.json b/packages/ui/grid/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@wpmudev/sui-grid",
   "version": "0.0.1",
-  "description": "WPMU DEV Shared UI React Grid Elements",
+  "description": "The Grid is composed of two fundamental components: Row and Column. It empowers you to create layouts and align content with precision on your web page",
   "keywords": [],
   "author": "WPMU DEV (https://wpmudev.com)",
   "contributors": [

diff --git a/packages/ui/icon/README.md b/packages/ui/icon/README.md
@@ -3,7 +3,7 @@
 <div style="text-align: center;">
 <img src="https://img.shields.io/badge/Version-0.0.1-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
 </div>
-<h2> Description </h2> WPMU DEV Shared UI React Global Hooks
+<h2> Description </h2> The Icon component serves as a container for SVG components, enabling the rendering of any SVG icon.
 
 
 [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#license)

diff --git a/packages/ui/icon/package.json b/packages/ui/icon/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@wpmudev/sui-icon",
   "version": "0.0.1",
-  "description": "WPMU DEV Shared UI React Global Hooks",
+  "description": "The Icon component serves as a container for SVG components, enabling the rendering of any SVG icon.",
   "keywords": [],
   "author": "WPMU DEV (https://wpmudev.com)",
   "license": "GPL-2.0",

diff --git a/packages/ui/password-field/README.md b/packages/ui/password-field/README.md
@@ -5,8 +5,9 @@
 </div>
 <h2> Description </h2> The Password Field component provides a secure input field for users to enter and conceal their passwords, ensuring confidentiality and protecting sensitive information
 
-[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#license)
-
+
+[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#license)
+
 ## ➤ License
-
+	
 Licensed under [GPL-2.0](https://opensource.org/licenses/GPL-2.0).
diff --git a/packages/ui/popover/README.md b/packages/ui/popover/README.md
@@ -1,9 +1,9 @@
-<!-- ⚠️ This README has been generated from the file(s) "../../../blueprint.md" ⚠️--><h1 align="center">@wpmudev/sui-tooltip</h1>
+<!-- ⚠️ This README has been generated from the file(s) "../../../blueprint.md" ⚠️--><h1 align="center">@wpmudev/sui-popover</h1>
 
 <div style="text-align: center;">
 <img src="https://img.shields.io/badge/Version-0.0.1-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
 </div>
-<h2> Description </h2> A tooltip is displayed to provide additional information about specific element when the user hovers or focuses on them.
+<h2> Description </h2> A popover is displayed to provide additional information about specific element when the user hovers or focuses on them.
 
 
 [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#license)

diff --git a/packages/ui/recipient/README.md b/packages/ui/recipient/README.md
@@ -3,7 +3,7 @@
 <div style="text-align: center;">
 <img src="https://img.shields.io/badge/Version-0.0.1-blue.svg" alt="Version"> <img src="https://img.shields.io/badge/License-GPL-orange.svg" alt="License">
 </div>
-<h2> Description </h2> The 'Recipient' Component simplifies user onboarding by providing a user-friendly interface for inviting users
+<h2> Description </h2> The Recipient component simplifies user onboarding by providing a user-friendly interface for inviting users
 
 
 [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#license)

diff --git a/packages/ui/recipient/package.json b/packages/ui/recipient/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@wpmudev/sui-recipient",
   "version": "0.0.1",
-  "description": "The 'Recipient' Component simplifies user onboarding by providing a user-friendly interface for inviting users",
+  "description": "The Recipient component simplifies user onboarding by providing a user-friendly interface for inviting users",
   "keywords": [],
   "author": "WPMU DEV (https://wpmudev.com)",
   "contributors": [