diff --git a/packages/a11y/README.md b/packages/a11y/README.md index d4d7b580a10a7..cb6c6cbe8a66c 100644 --- a/packages/a11y/README.md +++ b/packages/a11y/README.md @@ -1,6 +1,6 @@ -# @wordpress/a11y +# Accessibility (a11y) -Collection of JS modules for enhancing accessibility. +Accessibility utilities for WordPress. ## Installation diff --git a/packages/a11y/package.json b/packages/a11y/package.json index 52b7e4054b425..e4eba645cb907 100644 --- a/packages/a11y/package.json +++ b/packages/a11y/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/a11y", "version": "1.1.1", - "description": "Accessibility (a11y) utilities for WordPress", + "description": "Accessibility (a11y) utilities for WordPress.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/api-fetch/README.md b/packages/api-fetch/README.md index 6fc858200fa79..8cd0c05e2ead2 100644 --- a/packages/api-fetch/README.md +++ b/packages/api-fetch/README.md @@ -1,6 +1,6 @@ -# @wordpress/api-fetch +# API Fetch -Wrapper around `window.fetch` to call WordPress REST APIs. +Utility to make WordPress REST API requests. It's a wrapper around `window.fetch`. ## Installation diff --git a/packages/api-fetch/package.json b/packages/api-fetch/package.json index 373af059d4cbc..8f04b25e0e080 100644 --- a/packages/api-fetch/package.json +++ b/packages/api-fetch/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/api-fetch", "version": "1.0.1", - "description": "Utility to make WordPress REST API requests", + "description": "Utility to make WordPress REST API requests.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/autop/README.md b/packages/autop/README.md index 102fd962ab0ed..99db863357600 100644 --- a/packages/autop/README.md +++ b/packages/autop/README.md @@ -1,4 +1,4 @@ -# @wordpress/autop +# Autop JavaScript port of WordPress's automatic paragraph function `autop` and the `removep` reverse behavior. diff --git a/packages/autop/package.json b/packages/autop/package.json index 83acca63b2272..757150b8f0d7c 100644 --- a/packages/autop/package.json +++ b/packages/autop/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/autop", "version": "1.1.1", - "description": "WordPress's automatic paragraph functions `autop` and `removep`", + "description": "WordPress's automatic paragraph functions `autop` and `removep`.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/babel-plugin-import-jsx-pragma/README.md b/packages/babel-plugin-import-jsx-pragma/README.md index e3252d0178666..fc32f27a90204 100644 --- a/packages/babel-plugin-import-jsx-pragma/README.md +++ b/packages/babel-plugin-import-jsx-pragma/README.md @@ -1,5 +1,4 @@ -Babel Plugin Import JSX Pragma -====== +# Babel Plugin Import JSX Pragma Babel transform plugin for automatically injecting an import to be used as the pragma for the [React JSX Transform plugin](http://babeljs.io/docs/en/babel-plugin-transform-react-jsx). diff --git a/packages/babel-plugin-import-jsx-pragma/package.json b/packages/babel-plugin-import-jsx-pragma/package.json index 11611c90d2121..4710bc19d9a2c 100644 --- a/packages/babel-plugin-import-jsx-pragma/package.json +++ b/packages/babel-plugin-import-jsx-pragma/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/babel-plugin-import-jsx-pragma", "version": "1.0.1", - "description": "Babel transform plugin for automatically injecting an import to be used as the pragma for the React JSX Transform plugin", + "description": "Babel transform plugin for automatically injecting an import to be used as the pragma for the React JSX Transform plugin.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/babel-plugin-makepot/README.md b/packages/babel-plugin-makepot/README.md index 5fd0a9b49873a..06e8ceaf341d5 100644 --- a/packages/babel-plugin-makepot/README.md +++ b/packages/babel-plugin-makepot/README.md @@ -1,5 +1,4 @@ -Babel Plugin Makepot -====== +# Babel Plugin Makepot Babel plugin used to scan JavaScript files for use of localization functions. It then compiles these into a [gettext POT formatted](https://en.wikipedia.org/wiki/Gettext) file as a template for translation. By default the output file will be written to `gettext.pot` of the root project directory. This can be overridden using the `"output"` option of the plugin. diff --git a/packages/babel-plugin-makepot/package.json b/packages/babel-plugin-makepot/package.json index f2a496dddddd1..e6bd02feff71c 100644 --- a/packages/babel-plugin-makepot/package.json +++ b/packages/babel-plugin-makepot/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/babel-plugin-makepot", "version": "2.0.1", - "description": "WordPress Babel internationalization (i18n) plugin", + "description": "WordPress Babel internationalization (i18n) plugin.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/babel-preset-default/README.md b/packages/babel-preset-default/README.md index 647a73a13d52c..a83b18ae52d51 100644 --- a/packages/babel-preset-default/README.md +++ b/packages/babel-preset-default/README.md @@ -1,4 +1,4 @@ -# @wordpress/babel-preset-default +# Babel Preset Default Default [Babel](https://babeljs.io/) preset for WordPress development. diff --git a/packages/babel-preset-default/package.json b/packages/babel-preset-default/package.json index eca8d81054959..ace86804ca7b9 100644 --- a/packages/babel-preset-default/package.json +++ b/packages/babel-preset-default/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/babel-preset-default", "version": "2.0.2", - "description": "Default Babel preset for WordPress development", + "description": "Default Babel preset for WordPress development.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/blob/README.md b/packages/blob/README.md index c3673bc42edf5..d8f1b1b359aa4 100644 --- a/packages/blob/README.md +++ b/packages/blob/README.md @@ -1,6 +1,6 @@ -# @wordpress/blob +# Blob -Blob utils for WordPress. +Blob utilities for WordPress. ## Installation diff --git a/packages/blob/package.json b/packages/blob/package.json index 4b4810c98c2ac..30ed289698827 100644 --- a/packages/blob/package.json +++ b/packages/blob/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/blob", "version": "1.0.1", - "description": "Blob utilities for WordPress", + "description": "Blob utilities for WordPress.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/block-serialization-spec-parser/README.md b/packages/block-serialization-spec-parser/README.md index 36c93ddb6a236..c68989fd21605 100644 --- a/packages/block-serialization-spec-parser/README.md +++ b/packages/block-serialization-spec-parser/README.md @@ -1,4 +1,4 @@ -# @wordpress/block-serialization-spec-parser +# Block Serialization Spec Parser This library contains the grammar file (`grammar.pegjs`) for WordPress posts which is a block serialization _specification_ which is used to generate the actual _parser_ which is also bundled in this package. diff --git a/packages/block-serialization-spec-parser/package.json b/packages/block-serialization-spec-parser/package.json index 0b4e63c5db616..5481366ba0c51 100644 --- a/packages/block-serialization-spec-parser/package.json +++ b/packages/block-serialization-spec-parser/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/block-serialization-spec-parser", "version": "1.0.0", - "description": "Block serialization specification parser for WordPress posts", + "description": "Block serialization specification parser for WordPress posts.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/blocks/README.md b/packages/blocks/README.md index 40e214152125a..433aef4f56848 100644 --- a/packages/blocks/README.md +++ b/packages/blocks/README.md @@ -1,4 +1,4 @@ -# @wordpress/blocks +# Blocks "Block" is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage. The idea combines concepts diff --git a/packages/blocks/package.json b/packages/blocks/package.json index b10643cfa22e9..e81e49ef5fe45 100644 --- a/packages/blocks/package.json +++ b/packages/blocks/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/blocks", "version": "1.0.0", - "description": "Block API for WordPress", + "description": "Block API for WordPress.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/browserslist-config/README.md b/packages/browserslist-config/README.md index 08cc250d8408c..7889d74837f49 100644 --- a/packages/browserslist-config/README.md +++ b/packages/browserslist-config/README.md @@ -1,4 +1,4 @@ -# @wordpress/browserslist-config +# Browserslist Config [WordPress Browserslist](https://make.wordpress.org/core/handbook/best-practices/browser-support/) shareable config for [Browserslist](https://www.npmjs.com/package/browserslist). diff --git a/packages/browserslist-config/package.json b/packages/browserslist-config/package.json index fd252d16b23bc..f7eb7c8411cb6 100644 --- a/packages/browserslist-config/package.json +++ b/packages/browserslist-config/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/browserslist-config", "version": "2.2.0", - "description": "WordPress Browserslist shared configuration", + "description": "WordPress Browserslist shared configuration.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/components/README.md b/packages/components/README.md index 3ba3f12c6a6aa..2d019af3e59de 100644 --- a/packages/components/README.md +++ b/packages/components/README.md @@ -1,5 +1,4 @@ -Components -========== +# Components This packages includes a library of generic WordPress components to be used for creating common UI elements shared between screens and features of the WordPress dashboard. diff --git a/packages/components/package.json b/packages/components/package.json index 25ad7ab4c5ecb..d66d8b7abae37 100644 --- a/packages/components/package.json +++ b/packages/components/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/components", "version": "1.0.1", - "description": "UI components for WordPress", + "description": "UI components for WordPress.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/compose/README.md b/packages/compose/README.md index 8c98a6f5893a2..ac150a207bee8 100644 --- a/packages/compose/README.md +++ b/packages/compose/README.md @@ -1,6 +1,6 @@ -# @wordpress/compose +# Compose -The `compose` package is a collection of handy [Higher Order Components](https://facebook.github.io/react/docs/higher-order-components.html) you can use to wrap your WordPress components and provide some basic features like: State, instanceId, pure... +The `compose` package is a collection of handy [Higher Order Components](https://facebook.github.io/react/docs/higher-order-components.html) (HOCs) you can use to wrap your WordPress components and provide some basic features like: state, instance id, pure... ## Installation diff --git a/packages/compose/package.json b/packages/compose/package.json index 4b974a34a24ed..686f904616924 100644 --- a/packages/compose/package.json +++ b/packages/compose/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/compose", "version": "1.0.1", - "description": "WordPress higher-order components (HOCs)", + "description": "WordPress higher-order components (HOCs).", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/core-data/README.md b/packages/core-data/README.md index 6f308a1f2f6ca..ae7e4395882c1 100644 --- a/packages/core-data/README.md +++ b/packages/core-data/README.md @@ -1,5 +1,4 @@ -Core Data -========= +# Core Data Core Data is a [data module](../data) intended to simplify access to and manipulation of core WordPress entities. It registers its own store and provides a number of selectors which resolve data from the WordPress REST API automatically, along with dispatching action creators to manipulate data. diff --git a/packages/core-data/package.json b/packages/core-data/package.json index 35116d4ad2c87..84321b69558e4 100644 --- a/packages/core-data/package.json +++ b/packages/core-data/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/core-data", "version": "1.0.1", - "description": "Access to and manipulation of core WordPress entities", + "description": "Access to and manipulation of core WordPress entities.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/custom-templated-path-webpack-plugin/package.json b/packages/custom-templated-path-webpack-plugin/package.json index e4524a1375dca..e0319ab0fefe5 100644 --- a/packages/custom-templated-path-webpack-plugin/package.json +++ b/packages/custom-templated-path-webpack-plugin/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/custom-templated-path-webpack-plugin", "version": "1.1.2", - "description": "Webpack plugin for creating custom path template tags", + "description": "Webpack plugin for creating custom path template tags.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/data/README.md b/packages/data/README.md index 3dc091cb46692..46a47d6e3fdba 100644 --- a/packages/data/README.md +++ b/packages/data/README.md @@ -1,4 +1,4 @@ -# @wordpress/data +# Data WordPress' data module serves as a hub to manage application state for both plugins and WordPress itself, providing tools to manage data within and between distinct modules. It is designed as a modular pattern for organizing and sharing data: simple enough to satisfy the needs of a small plugin, while scalable to serve the requirements of a complex single-page application. diff --git a/packages/data/package.json b/packages/data/package.json index 874752cf77797..ce62cdab4dfa4 100644 --- a/packages/data/package.json +++ b/packages/data/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/data", "version": "1.0.1", - "description": "Data module for WordPress", + "description": "Data module for WordPress.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/date/README.md b/packages/date/README.md index 9ac94cabaca9e..6e807d47098b0 100644 --- a/packages/date/README.md +++ b/packages/date/README.md @@ -1,4 +1,4 @@ -# @wordpress/date +# Date Date module for WordPress. diff --git a/packages/date/package.json b/packages/date/package.json index eb1f493b7170b..9d343f7bb357b 100644 --- a/packages/date/package.json +++ b/packages/date/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/date", "version": "1.0.1", - "description": "Date module for WordPress", + "description": "Date module for WordPress.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/deprecated/README.md b/packages/deprecated/README.md index 7baba14b53f32..77f1a17fa4ed6 100644 --- a/packages/deprecated/README.md +++ b/packages/deprecated/README.md @@ -1,6 +1,6 @@ -# @wordpress/deprecated +# Deprecated -Logs a message to notify developers about a deprecated feature. +Deprecation utility for WordPress. Logs a message to notify developers about a deprecated feature. ## Installation diff --git a/packages/deprecated/package.json b/packages/deprecated/package.json index bc662988009f7..6731ea7ccff29 100644 --- a/packages/deprecated/package.json +++ b/packages/deprecated/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/deprecated", "version": "1.0.1", - "description": "Deprecation utility for WordPress", + "description": "Deprecation utility for WordPress.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/dom-ready/README.md b/packages/dom-ready/README.md index b9bc37c4d2726..5fb534a3c64ac 100644 --- a/packages/dom-ready/README.md +++ b/packages/dom-ready/README.md @@ -1,6 +1,6 @@ -# @wordpress/dom-ready +# DOM Ready -Executes a function after the DOM has loaded. +Execute callback after the DOM is loaded. ## Installation diff --git a/packages/dom-ready/package.json b/packages/dom-ready/package.json index 269aaa15d77f1..abfe4dcfe03b2 100644 --- a/packages/dom-ready/package.json +++ b/packages/dom-ready/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/dom-ready", "version": "1.1.1", - "description": "Execute callback after the DOM is loaded", + "description": "Execute callback after the DOM is loaded.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/dom/README.md b/packages/dom/README.md index 3829ed59c8940..f5e890dd7d06e 100644 --- a/packages/dom/README.md +++ b/packages/dom/README.md @@ -1,6 +1,6 @@ -# @wordpress/dom +# DOM -DOM utils module for WordPress. +DOM utilities module for WordPress. ## Installation diff --git a/packages/dom/package.json b/packages/dom/package.json index cb005d3803244..dcc7031dd2602 100644 --- a/packages/dom/package.json +++ b/packages/dom/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/dom", "version": "1.0.1", - "description": "DOM utilities module for WordPress", + "description": "DOM utilities module for WordPress.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/element/README.md b/packages/element/README.md index 23ea3cef7b652..ebed8737e8c1b 100644 --- a/packages/element/README.md +++ b/packages/element/README.md @@ -1,4 +1,4 @@ -# @wordpress/element +# Element Element is, quite simply, an abstraction layer atop [React](https://reactjs.org/). diff --git a/packages/element/package.json b/packages/element/package.json index 7371ac47437f0..9e0e1d177c7f9 100644 --- a/packages/element/package.json +++ b/packages/element/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/element", "version": "1.0.1", - "description": "Element React module for WordPress", + "description": "Element React module for WordPress.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/hooks/README.md b/packages/hooks/README.md index ffc54ab0b216f..fd33d8a040019 100644 --- a/packages/hooks/README.md +++ b/packages/hooks/README.md @@ -1,4 +1,4 @@ -# @wordpress/hooks +# Hooks A lightweight & efficient EventManager for JavaScript. diff --git a/packages/hooks/package.json b/packages/hooks/package.json index 4947bac9aaebc..c3b1ac9905b6a 100644 --- a/packages/hooks/package.json +++ b/packages/hooks/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/hooks", "version": "1.3.1", - "description": "WordPress hooks library", + "description": "WordPress hooks library.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/html-entities/README.md b/packages/html-entities/README.md index 11f6e760994c9..a30ccbbc9a9a6 100644 --- a/packages/html-entities/README.md +++ b/packages/html-entities/README.md @@ -1,6 +1,6 @@ -# @wordpress/html-entities +# HTML Entities -HTML entities utils for WordPress. +HTML entity utilities for WordPress. ## Installation diff --git a/packages/html-entities/package.json b/packages/html-entities/package.json index d13a6db0a424f..f3eabb40fc663 100644 --- a/packages/html-entities/package.json +++ b/packages/html-entities/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/html-entities", "version": "1.0.1", - "description": "HTML entity utilties for WordPress", + "description": "HTML entity utilities for WordPress.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/i18n/README.md b/packages/i18n/README.md index 6babc746ebfc5..3041dea6612f9 100644 --- a/packages/i18n/README.md +++ b/packages/i18n/README.md @@ -1,5 +1,4 @@ -@wordpress/i18n -====== +# Internationalization (i18n) Internationalization utilities for client-side localization. diff --git a/packages/i18n/package.json b/packages/i18n/package.json index 7565c4a282f6f..23d580aad5893 100644 --- a/packages/i18n/package.json +++ b/packages/i18n/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/i18n", "version": "1.2.1", - "description": "WordPress internationalization (i18n) library", + "description": "WordPress internationalization (i18n) library.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/is-shallow-equal/README.md b/packages/is-shallow-equal/README.md index 0b0c2d7aad731..e6e0c4ab4d4c8 100644 --- a/packages/is-shallow-equal/README.md +++ b/packages/is-shallow-equal/README.md @@ -1,4 +1,4 @@ -# @wordpress/is-shallow-equal +# Is Shallow Equal A function for performing a shallow comparison between two objects or arrays. Two values have shallow equality when all of their members are strictly equal to the corresponding member of the other. diff --git a/packages/is-shallow-equal/package.json b/packages/is-shallow-equal/package.json index 722049d5a4fb9..cda831f668467 100644 --- a/packages/is-shallow-equal/package.json +++ b/packages/is-shallow-equal/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/is-shallow-equal", "version": "1.1.1", - "description": "Test for shallow equality between two objects or arrays", + "description": "Test for shallow equality between two objects or arrays.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/jest-console/README.md b/packages/jest-console/README.md index dfedb18eb2714..18c3cb1e7bb15 100644 --- a/packages/jest-console/README.md +++ b/packages/jest-console/README.md @@ -1,4 +1,4 @@ -# @wordpress/jest-console +# Jest Console Custom [Jest](http://facebook.github.io/jest/) matchers for the [Console](https://developer.mozilla.org/en-US/docs/Web/API/Console) object to test JavaScript code in WordPress. diff --git a/packages/jest-console/package.json b/packages/jest-console/package.json index 9952e0a0fd2e5..607a0544ce748 100644 --- a/packages/jest-console/package.json +++ b/packages/jest-console/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/jest-console", "version": "2.0.1", - "description": "Custom Jest matchers for the Console object", + "description": "Custom Jest matchers for the Console object.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/jest-preset-default/README.md b/packages/jest-preset-default/README.md index da1881ca76093..826e11af09d22 100644 --- a/packages/jest-preset-default/README.md +++ b/packages/jest-preset-default/README.md @@ -1,4 +1,4 @@ -# @wordpress/jest-preset-default +# Jest Preset Default Default [Jest](https://facebook.github.io/jest/) preset for WordPress development. diff --git a/packages/jest-preset-default/package.json b/packages/jest-preset-default/package.json index 65478631ec4de..27afc07894df2 100644 --- a/packages/jest-preset-default/package.json +++ b/packages/jest-preset-default/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/jest-preset-default", "version": "2.0.1", - "description": "Default Jest preset for WordPress development", + "description": "Default Jest preset for WordPress development.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/keycodes/README.md b/packages/keycodes/README.md index 3fafb5dcba856..c692278e785df 100644 --- a/packages/keycodes/README.md +++ b/packages/keycodes/README.md @@ -1,4 +1,4 @@ -# @wordpress/keycodes +# Keycodes Keycodes utilities for WordPress, used to check the key pressed in events like `onKeyDown`. Contains keycodes constants for keyboard keys like `DOWN`, `UP`, `ENTER`, etc. diff --git a/packages/keycodes/package.json b/packages/keycodes/package.json index d717ffbc73118..d10b42a4a125b 100644 --- a/packages/keycodes/package.json +++ b/packages/keycodes/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/keycodes", "version": "1.0.1", - "description": "Keycodes utilities for WordPress; used to check for keyboard events across browsers/operating systems", + "description": "Keycodes utilities for WordPress. Used to check for keyboard events across browsers/operating systems.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/library-export-default-webpack-plugin/README.md b/packages/library-export-default-webpack-plugin/README.md index 84f5e6f3a603c..2438b43d39491 100644 --- a/packages/library-export-default-webpack-plugin/README.md +++ b/packages/library-export-default-webpack-plugin/README.md @@ -1,8 +1,8 @@ -# @wordpress/library-export-default-webpack-plugin +# Library Export Default Webpack Plugin -Webpack plugin for exporting default property for selected libraries. Implementation is based on the Webpack's core plugin [ExportPropertyMainTemplatePlugin](https://github.com/webpack/webpack/blob/51b0df77e4f366163730ee465f01458bfad81f34/lib/ExportPropertyMainTemplatePlugin.js). The only difference is that this plugin allows to whitelist all entry point names where the default export of your entry point will be assigned to the library target. +Webpack plugin for exporting `default` property for selected libraries which use ES6 Modules. Implementation is based on the Webpack's core plugin [ExportPropertyMainTemplatePlugin](https://github.com/webpack/webpack/blob/51b0df77e4f366163730ee465f01458bfad81f34/lib/ExportPropertyMainTemplatePlugin.js). The only difference is that this plugin allows to whitelist all entry point names where the default export of your entry point will be assigned to the library target. -**Note**: This plugin targets Webpack 4.0 and newer, and is not compatible with older versions. +**Note**: This plugin requires Webpack 4.0 and newer, and is not compatible with older versions. ## Installation diff --git a/packages/library-export-default-webpack-plugin/package.json b/packages/library-export-default-webpack-plugin/package.json index a0e4d64b10e6d..c6e3933e363a4 100644 --- a/packages/library-export-default-webpack-plugin/package.json +++ b/packages/library-export-default-webpack-plugin/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/library-export-default-webpack-plugin", "version": "1.0.1", - "description": "Webpack plugin for exporting default property for selected libraries", + "description": "Webpack plugin for exporting default property for selected libraries.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/npm-package-json-lint-config/README.md b/packages/npm-package-json-lint-config/README.md index 3cbbaae606290..926b083129d9b 100644 --- a/packages/npm-package-json-lint-config/README.md +++ b/packages/npm-package-json-lint-config/README.md @@ -1,6 +1,6 @@ -# `@wordpress/npm-package-json-lint-config` +# NPM Package.json Lint Config -> WordPress [npm-package-json-lint](https://github.com/tclindner/npm-package-json-lint) shareable config +WordPress [npm-package-json-lint](https://github.com/tclindner/npm-package-json-lint) shareable configuration. ## Installation diff --git a/packages/npm-package-json-lint-config/package.json b/packages/npm-package-json-lint-config/package.json index 69537707b5c4c..e1da3b1a587cd 100644 --- a/packages/npm-package-json-lint-config/package.json +++ b/packages/npm-package-json-lint-config/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/npm-package-json-lint-config", "version": "1.1.1", - "description": "WordPress npm-package-json-lint shareable configuration", + "description": "WordPress npm-package-json-lint shareable configuration.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/nux/README.md b/packages/nux/README.md index 2b490aa791873..fac0c8c8c4f23 100644 --- a/packages/nux/README.md +++ b/packages/nux/README.md @@ -1,6 +1,6 @@ -# @wordpress/nux +# New User eXperience (NUX) -The NUX (New User eXperience) module exposes components, and `wp.data` methods useful for onboarding a new user to the WordPress admin interface. Specifically, it exposes _tips_ and _guides_. +The NUX module exposes components, and `wp.data` methods useful for onboarding a new user to the WordPress admin interface. Specifically, it exposes _tips_ and _guides_. A _tip_ is a component that points to an element in the UI and contains text that explains the element's functionality. The user can dismiss a tip, in which case it never shows again. The user can also disable tips entirely. Information about tips is persisted between sessions using `localStorage`. diff --git a/packages/nux/package.json b/packages/nux/package.json index d5a481d7fc1e7..f1c4fb25625f2 100644 --- a/packages/nux/package.json +++ b/packages/nux/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/nux", "version": "1.0.0", - "description": "NUX (New User eXperience) module for WordPress", + "description": "NUX (New User eXperience) module for WordPress.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/plugins/README.md b/packages/plugins/README.md index f52a26793d269..6c92702b86346 100644 --- a/packages/plugins/README.md +++ b/packages/plugins/README.md @@ -1,4 +1,4 @@ -# @wordpress/plugins +# Plugins Plugins module for WordPress. diff --git a/packages/plugins/package.json b/packages/plugins/package.json index e4f6469245497..70a7e435231b3 100644 --- a/packages/plugins/package.json +++ b/packages/plugins/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/plugins", "version": "1.0.1", - "description": "Plugins module for WordPress", + "description": "Plugins module for WordPress.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/postcss-themes/README.md b/packages/postcss-themes/README.md index cc7be92c411b7..22ebf22c44943 100644 --- a/packages/postcss-themes/README.md +++ b/packages/postcss-themes/README.md @@ -1,6 +1,6 @@ -# @wordpress/postcss-themes +# PostCSS Themes -PostCSS Plugin to generate theme colors +PostCSS plugin to generate theme colors. ## Installation diff --git a/packages/postcss-themes/package.json b/packages/postcss-themes/package.json index 310d70f11f31b..865bba07a4cad 100644 --- a/packages/postcss-themes/package.json +++ b/packages/postcss-themes/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/postcss-themes", "version": "1.0.1", - "description": "PostCSS plugin to generate theme colors", + "description": "PostCSS plugin to generate theme colors.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/scripts/README.md b/packages/scripts/README.md index 3d0d4b76dd86e..c8620ab3e8ad8 100644 --- a/packages/scripts/README.md +++ b/packages/scripts/README.md @@ -1,6 +1,6 @@ -# @wordpress/scripts +# Scripts -A collection of JS scripts for WordPress development. +Collection of JS scripts for WordPress development. ## Installation diff --git a/packages/scripts/package.json b/packages/scripts/package.json index 3799a2f385e43..6e9a42b3bfaad 100644 --- a/packages/scripts/package.json +++ b/packages/scripts/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/scripts", "version": "2.0.2", - "description": "Collection of JS scripts for WordPress development", + "description": "Collection of JS scripts for WordPress development.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/shortcode/README.md b/packages/shortcode/README.md index ae2f3a41fc206..c67a3e3e06b69 100644 --- a/packages/shortcode/README.md +++ b/packages/shortcode/README.md @@ -1,6 +1,6 @@ -# @wordpress/shortcode +# Shortcode -Shortcode utils for WordPress. +Shortcode module for WordPress. ## Installation diff --git a/packages/shortcode/package.json b/packages/shortcode/package.json index 370df9fd42d44..0170395f3c78e 100644 --- a/packages/shortcode/package.json +++ b/packages/shortcode/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/shortcode", "version": "1.0.1", - "description": "Shortcode module for WordPress", + "description": "Shortcode module for WordPress.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/url/README.md b/packages/url/README.md index 933b46a371a9d..e50d2f142def4 100644 --- a/packages/url/README.md +++ b/packages/url/README.md @@ -1,6 +1,6 @@ -# @wordpress/url +# URL -A collection of utilities to manipulate URLs +A collection of utilities to manipulate URLs. ## Installation diff --git a/packages/url/package.json b/packages/url/package.json index 6806bf3fc34f5..4657460af92a2 100644 --- a/packages/url/package.json +++ b/packages/url/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/url", "version": "1.2.1", - "description": "WordPress URL utilities", + "description": "WordPress URL utilities.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/viewport/README.md b/packages/viewport/README.md index 879ca9c887d46..57862c1cded10 100644 --- a/packages/viewport/README.md +++ b/packages/viewport/README.md @@ -1,4 +1,4 @@ -# @wordpress/viewport +# Viewport Viewport is a module for responding to changes in the browser viewport size. It registers its own [data module](https://github.com/WordPress/gutenberg/tree/master/packages/data), updated in response to browser media queries on a standard set of supported breakpoints. This data and the included higher-order components can be used in your own modules and components to implement viewport-dependent behaviors. diff --git a/packages/viewport/package.json b/packages/viewport/package.json index 249a9f150c126..cf7e1e3ac09ce 100644 --- a/packages/viewport/package.json +++ b/packages/viewport/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/viewport", "version": "1.0.1", - "description": "Viewport module for WordPress", + "description": "Viewport module for WordPress.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/packages/wordcount/README.md b/packages/wordcount/README.md index c872b3c0cd028..f5c9ba2084f50 100644 --- a/packages/wordcount/README.md +++ b/packages/wordcount/README.md @@ -1,6 +1,6 @@ -# @wordpress/wordcount +# Word Count -A utility to count words +WordPress word count utility. ## Installation diff --git a/packages/wordcount/package.json b/packages/wordcount/package.json index 08c648438cc38..3eaf4734115cd 100644 --- a/packages/wordcount/package.json +++ b/packages/wordcount/package.json @@ -1,7 +1,7 @@ { "name": "@wordpress/wordcount", "version": "1.1.1", - "description": "WordPress word count utility", + "description": "WordPress word count utility.", "author": "The WordPress Contributors", "license": "GPL-2.0-or-later", "keywords": [