Merge pull request #17 from 10up/update/readme

Update/readme

README.md

@@ -1,23 +1,19 @@
-# Figma Block
+# Figma Block for WordPress
 
 > Adds a Figma embed block to the WordPress Block Editor.
 
 [![Support Level](https://img.shields.io/badge/support-beta-blueviolet.svg)](#support-level) ![WordPress tested up to version](https://img.shields.io/badge/WordPress-v6.5%20tested-success.svg) [![GPLv2 License](https://img.shields.io/github/license/10up/block-catalog.svg)](https://github.com/10up/block-catalog/blob/develop/LICENSE.md)
+[![Dependency Review](https://github.com/10up/figma-block/actions/workflows/dependency-review.yml/badge.svg)](https://github.com/10up/figma-block/actions/workflows/dependency-review.yml) [![PHP Compatibility](https://github.com/10up/figma-block/actions/workflows/php-compat.yml/badge.svg)](https://github.com/10up/figma-block/actions/workflows/php-compat.yml) [![PHP Linting](https://github.com/10up/figma-block/actions/workflows/phpcs.yml/badge.svg)](https://github.com/10up/figma-block/actions/workflows/phpcs.yml) [![JS Linting](https://github.com/10up/figma-block/actions/workflows/eslint.yml/badge.svg)](https://github.com/10up/figma-block/actions/workflows/eslint.yml)
 
-## Table of Contents
-
-* [Features](#features)
-* [Requirements](#requirements)
-* [Installation](#installation)
-* [Getting Started](#getting-started)
-* [Support](#support-level)
-* [Changelog](#changelog)
-* [Contributing](#contributing)
+![Screenshot of the rendered Figma Embed block in the editor / admin](.wordpress-org/screenshot-2.png)
 
 ## Features
 
 * Embed a Figma file using a block in the WordPress editor.
 * Paste a Figma URL on a new line in the Block Editor to automatically convert it to a Figma Embed block.
+* Block settings allow for altering margins of rendered Figma file embed
+
+![Screenshot of the Figma Embed block settings prior to rendering in the editor / admin](.wordpress-org/screenshot-3.png)
 
 ## Requirements
 
@@ -33,9 +29,11 @@
 
 Once the plugin is installed and activated, you should see a new Figma Embed block. Insert this block into your content and enter the URL of the Figma file you want to embed.
 
+![Screenshot of Figma Embed block with sample URL pre-embed](.wordpress-org/screenshot-1.png)
+
 Assuming it's a valid URL, the block will automatically fetch the Figma file and display it in the editor. Once saved, this will also display on the front-end.
 
-![Screenshot of Figma Embed block](.wordpress-org/screenshot-1.png)
+![Screenshot of the front-end rendering of the Figma Embed block](.wordpress-org/screenshot-4.png)
 
 ## Support Level
 

composer.json

@@ -2,11 +2,13 @@
   "name": "10up/figma-block",
   "description": "Adds a Figma embed block to the WordPress Block Editor.",
   "type": "wordpress-plugin",
-  "license": "GPLv2",
+  "homepage": "https://github.com/10up/figma-block",
+  "license": "GPL-2.0-or-later",
   "authors": [
     {
       "name": "10up",
-      "email": "[email protected]"
+      "email": "[email protected]",
+      "homepage": "https://10up.com"
     }
   ],
   "autoload": {

figma-block.php

@@ -3,15 +3,15 @@
  * Plugin Name:       Figma Block
  * Plugin URI:        https://10up.com
  * Description:       Adds a Figma embed block to the WordPress Block Editor.
+ * Version:           0.1.0
+ * Requires at least: 6.4
+ * Requires PHP:      7.4
  * Author:            10up
  * Author URI:        https://10up.com
- * License:           GPL v2 or later
- * License URI:       https://www.gnu.org/licenses/gpl-2.0.html
+ * License:           GPL-2.0-or-later
+ * License URI:       https://spdx.org/licenses/GPL-2.0-or-later.html
  * Text Domain:       figma-block
  * Domain Path:       /languages
- * Version:           0.1.0
- * Requires at least: 6.4
- * Requires PHP:      7.4
  *
  * @package FigmaBlock
  */

package.json

@@ -2,6 +2,12 @@
   "name": "figma-block",
   "version": "0.1.0",
   "description": "Adds a Figma embed block to the WordPress Block Editor.",
+  "homepage": "https://github.com/10up/figma-block",
+  "license": "GPL-2.0-or-later",
+  "author": {
+    "name": "10up",
+    "email": "[email protected]",
+    "url": "https://10up.com"},
   "scripts": {
     "start": "10up-toolkit start",
     "watch": "10up-toolkit watch --port=3000 --hot",

readme.txt

@@ -1,26 +1,25 @@
 === Block Catalog ===
-Contributors:      10up, dkotter
+Contributors:      10up, dkotter, jeffpaul
 Tags:              gutenberg, figma, embed, blocks, custom blocks
-Requires at least: 6.4
 Tested up to:      6.5
-Requires PHP:      7.4
 Stable tag:        0.1.0
-License:           GPLv2 or later
-License URI:       http://www.gnu.org/licenses/gpl-2.0.html
+License:           GPL-2.0-or-later
+License URI:       https://spdx.org/licenses/GPL-2.0-or-later.html
 
 Display Figma files using an Embed block.
 
 == Description ==
 
 * Embed a Figma file using a block in the WordPress editor.
 * Paste a Figma URL on a new line in the Block Editor to automatically convert it to a Figma Embed block.
+* Block settings allow for altering margins of rendered Figma file embed
 
 == Screenshots ==
 
-1. The Figma Embed block.
-2. The rendered Figma Embed block in the admin.
-3. The block settings prior to rendering.
-4. Front-end rendering of the block.
+1. The Figma Embed block with sample URL pre-embed.
+2. The rendered Figma Embed block in the editor / admin.
+3. The Figma Embed block settings prior to rendering in the editor / admin.
+4. Front-end rendering of the Figma Embed block.
 
 == Getting Started ==