@webflow/webflow-cli 1.6.1 → 1.6.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @webflow/webflow-cli
 
+## 1.6.3
+
+### Patch Changes
+
+- Updated README
+
+## 1.6.2
+
+### Minor Changes
+
+- Updating supported file types, adding check for index.html during extension bundling
+
 ## 1.6.1
 
 ### Minor Changes

package/README.md

@@ -1,25 +1,67 @@
 # Webflow CLI
 
-## Install
+The Webflow CLI is a command-line interface that allows you to interact with various Webflow developer products, including Devlink and Designer Extensions.
+
+## Installation
+
+You can install the Webflow CLI globally on your machine using npm:
 
 ```shell
-npm i @webflow/webflow-cli
+npm i @webflow/webflow-cli -g
 ```
 
-## Usage
+# Usage
+
+- [Webflow Designer APIs & Extensions](#webflow-designer-apis-and-extensions)
+- [Devlink](#devlink)
+
+## Webflow Designer Extensions and APIs
+[Designer Extensions](https://docs.developers.webflow.com/v2.0.0/docs/apps-overview) are single-page web Apps that run inside of of the Webflow Designer, and manipulate elements on the canvas through [Webflow's Designer APIs.](https://docs.developers.webflow.com/v2.0.0/reference/introduction-1). You can use the Webflow CLI to develop and package your Designer Extensions.
 
+### Creating an Extension
+To create a new extension, use the `webflow extension init` command:
+
+```shell
+webflow extension init my-extension
+```
+
+This command creates a new directory named `my-extension` with a basic scaffold for your extension. See more details about the scaffolding on the [App structure reference](https://docs.developers.webflow.com/v2.0.0/reference/app-structure).
+
+### Running your Extension Locally
+
+Navigate to the newly created folder for your extension. You can serve your extension locally using the following command. The default port is set to 1337.
+
+```shell
+npm run dev
+```
+This will run the `webflow extension serve` and command, allowing you test your App locally.
+
+### Building and Bundling your Extension
+
+If you're using the scaffolding built out from the `webflow extension init` command, you can create a build of your extension, an bundle it for publishing using the` npm run build` command:
+
+```shell
+npm run build
+```
+
+This will run the `webflow extension bundle` CLI command, which will output a `bundle.zip` file in your extension’s directory. You can upload this extension to Webflow via the "Integrations" tab in your workspace settings. Note: The extension size limit is 5MB.
+
+# Devlink
+
+DevLink allows you to visually design and build web components for React directly in Webflow. [Learn more in our DevLink overview,](https://webflow.com/devlink) and read the [DevLink documentation](https://docs.developers.webflow.com/docs/devlink-documentation-and-usage-guide).
 
-### DevLink
 ```shell
 npx webflow devlink -h
 ```
 
-In order to use the DevLink CLI first you'll need to create a `.webflowrc` configuration file on your application's root directory. 
-The supported formats are JavaScript(.js) and JSON (.json). 
+In order to use the DevLink CLI first you'll need to create a `.webflowrc` configuration file on your application's root directory.
+
+The supported formats are JavaScript(.js) and JSON (.json).
 
 It should look something like this:
 
 JSON:
+
 ```json
 {
   "host": "https://api.wfdev.io:8443",
@@ -30,6 +72,7 @@ JSON:
 ```
 
 JavaScript:
+
 ```js
 module.exports = {
   host: "https://api.wfdev.io:8443",
@@ -49,4 +92,5 @@ npx webflow devlink sync
 ```
 
 # Terms of Service
+
 By using Webflow DevLink you agree to the [Webflow Labs Terms of Service](https://webflow.com/legal/labs-terms).