📕 docs(none): add community extensions to README.md (#2445)

## Type of change **NONE: internal change**
roots · Sep 12, 2023 · 6e0d9a4 · 6e0d9a4
1 parent 4c845ed
commit 6e0d9a4
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -14,20 +14,16 @@
 
 ---
 
-## What is bud.js?
-
-Configurable, extensible build tools for modern single and multi-page web applications.
-
-### Goals
+## Goals
 
 **bud.js** wants to be:
 
 - **Reliable**, yielding consistent and predictable behaviors regardless of specified options.
 - **Fast**, leveraging parallel processing, smart caching and an asyncronous events based API to keep build times minimal.
-- **Extensible**, with a fully featured plugin system to support an ecosystem of packaged modules
-- **Simple**, to get started and straight forward to maintain
+- **Extensible**, with a fully featured plugin system to support an ecosystem of packaged modules.
+- **Simple**, to get started and straight forward to maintain.
 
-### Features
+## Features
 
 - Zero config by default. Check out this [codesandbox template with react, postcss modules and no config](https://codesandbox.io/s/bud-zero-config-or4tby).
 - Modular by design. Use only what you need.
@@ -119,6 +115,12 @@ Also included in the bud monorepo are packages which are not specific to bud.js
 | [**@roots/wordpress-theme-json-webpack-plugin**](https://github.com/roots/bud/tree/main/sources/@roots/wordpress-theme-json-webpack-plugin)     | ![npm](https://img.shields.io/npm/v/@roots/wordpress-theme-json-webpack-plugin.svg?color=%23525ddc&style=flat-square)   |
 | [**@roots/wordpress-transforms**](https://github.com/roots/bud/tree/main/sources/@roots/wordpress-transforms)                                   | ![npm](https://img.shields.io/npm/v/@roots/wordpress-transforms.svg?color=%23525ddc&style=flat-square)                  |
 
+## Community extensions
+
+| Package                                                                         | Latest                                                                                  |
+| ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
+| [**bud-embedded**](https://github.com/roots/bud/tree/main/sources/bud-embedded) | ![npm](https://img.shields.io/npm/v/bud-embedded.svg?color=%23525ddc&style=flat-square) |
+
 ## Contributing
 
 Contributions are welcome from everyone.

diff --git a/sources/@repo/markdown-kit/readme/partials/what.md b/sources/@repo/markdown-kit/readme/partials/what.md
@@ -1,15 +1,13 @@
-Configurable, extensible build tools for modern single and multi-page web applications.
-
-### Goals
+## Goals
 
 **bud.js** wants to be:
 
 - **Reliable**, yielding consistent and predictable behaviors regardless of specified options.
 - **Fast**, leveraging parallel processing, smart caching and an asyncronous events based API to keep build times minimal.
-- **Extensible**, with a fully featured plugin system to support an ecosystem of packaged modules
-- **Simple**, to get started and straight forward to maintain
+- **Extensible**, with a fully featured plugin system to support an ecosystem of packaged modules.
+- **Simple**, to get started and straight forward to maintain.
 
-### Features
+## Features
 
 - Zero config by default. Check out this [codesandbox template with react, postcss modules and no config](https://codesandbox.io/s/bud-zero-config-or4tby).
 - Modular by design. Use only what you need.

diff --git a/sources/@repo/markdown-kit/readme/templates/root.md b/sources/@repo/markdown-kit/readme/templates/root.md
@@ -1,7 +1,5 @@
 {{>banner}}
 
-## What is bud.js?
-
 {{>what}}
 
 ## Requirements
@@ -82,6 +80,12 @@ Also included in the bud monorepo are packages which are not specific to bud.js
 | [**@roots/wordpress-theme-json-webpack-plugin**]({{projectConfig.url.web}}/tree/main/sources/@roots/wordpress-theme-json-webpack-plugin)     | ![npm](https://img.shields.io/npm/v/@roots/wordpress-theme-json-webpack-plugin.svg?color=%23525ddc&style=flat-square)   |
 | [**@roots/wordpress-transforms**]({{projectConfig.url.web}}/tree/main/sources/@roots/wordpress-transforms)                                   | ![npm](https://img.shields.io/npm/v/@roots/wordpress-transforms.svg?color=%23525ddc&style=flat-square)                  |
 
+## Community extensions
+
+| Package                                                                                                                                         | Latest                                                                                                                  |
+| -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| [**bud-embedded**]({{projectConfig.url.web}}/tree/main/sources/bud-embedded)                                                   | ![npm](https://img.shields.io/npm/v/bud-embedded.svg?color=%23525ddc&style=flat-square)                          |
+
 ## Contributing
 
 {{>contributing}}

diff --git a/sources/@roots/wordpress-hmr/README.md b/sources/@roots/wordpress-hmr/README.md
@@ -231,7 +231,7 @@ export const callback = (settings, name) => {
 Using a default export
 
 ```js title=src/example.filter.js
-import {assign} from 'lodash'
+import { assign } from "lodash";
 
 export default {
   /** Filter id */
@@ -240,17 +240,18 @@ export default {
   hook: `blocks.registerBlockType`,
   /** Filter callback */
   callback: (settings, name) => {
-  if (name !== 'core/list') return settings;
-
-  return assign({}, settings, {
-    example: {
-      innerBlocks: [
-        {name: 'core/list-item', attributes: {content: 'Item a'}},
-        {name: 'core/list-item', attributes: {content: 'Item b'}},
-      ],
-    },
-  })
-}
+    if (name !== "core/list") return settings;
+
+    return assign({}, settings, {
+      example: {
+        innerBlocks: [
+          { name: "core/list-item", attributes: { content: "Item a" } },
+          { name: "core/list-item", attributes: { content: "Item b" } },
+        ],
+      },
+    });
+  },
+};
 ```
 
 ## Registering filters from a block or plugin