From 8230ee77ee81f63e78c8e5dd9d039ed35a87a885 Mon Sep 17 00:00:00 2001 From: Jake Albaugh Date: Fri, 21 Jun 2024 17:04:03 -0500 Subject: [PATCH] readme --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 17b5c8d..64e93ae 100644 --- a/README.md +++ b/README.md @@ -98,21 +98,22 @@ All Code Connect docs and Storybook stories follow the same categorization are d ## Scripts -Some example integrations are available in `scripts` directory. They may require additional API scope that your org may or may not have access to. Where possible, there are some plugins examples to help fill gaps. +Some example integrations are available in `scripts` directory. They may require additional API scope that your org may or may not have access to. Where possible, there are some plugin examples to help fill gaps. ### [scripts/component-metadata](./scripts/component-metadata) -- JS Console in Figma scripts -- Used to bulk manage descriptions for all components in the file. Instead of making a complicated plugin, you can do this more simply by running scripts in the JavaScript console. +- Scripts to run in the JS Console in Figma +- Bulk manage descriptions for all components in the file. Instead of making a complicated plugin, you can do this more simply by running scripts directly from the JavaScript console. - Copy the contents of [scripts/component-metadata/exportComponentJSON.js](./scripts/component-metadata/exportComponentJSON.js) and run in the console with the file open. - "Copy as object" the result and paste into [scripts/component-metadata/components.json](./scripts/component-metadata/components.json). -- There you can modify descriptions more easily. Once you have modified the descriptions, copy the JSON and paste at the top of [scripts/component-metadata/importComponentJSON.js](./scripts/component-metadata/importComponentJSON.js) as the value of the `json` variable. -- Then copy the contents of the file and run in the console to batch update descriptions for the entire file. +- There you can modify descriptions more easily. +- Once you have modified the descriptions, copy the JSON and paste at the top of [scripts/component-metadata/importComponentJSON.js](./scripts/component-metadata/importComponentJSON.js) as the value of the `json` variable. +- Copy all the contents of the import file and run in the console to batch update descriptions for the entire file. - **This will only update the descriptions.** To update Dev Resources, you can use [scripts/dev-resources](#scriptsdev-resources). ### [scripts/dev-resources](./scripts/dev-resources) -- `npm run script:dev-resources` +- `npm run script:dev-resources` (REST API only) - Sets dev resources for all components described in [scripts/dev-resources/devResources.mjs](./scripts/dev-resources/devResources.mjs) to match. - Useful when swapping urls in bulk. Requires `Dev Resources: Write` scope on your REST API token. @@ -120,7 +121,7 @@ Some example integrations are available in `scripts` directory. They may require - `npm run script:icons:rest` - Gets all icons from the file, and generates components in the [src/ui/icons](./src/ui/icons) directory. -- Also generates [src/figma/icons](./src/figma/icons) for Code Connect. +- Also generates [src/figma/icons/Icons.figma.tsx](./src/figma/icons/Icons.figma.tsx) for Code Connect. ### [scripts/tokens](./scripts/tokens)