docs: Update READMEs and descriptions

Sidnioulz · Nov 2, 2024 · c76a361 · c76a361
1 parent 663b585
commit c76a361
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -51,9 +51,9 @@
 
 <!-- no toc -->
 - [Key Projects](#star2-key-projects)
-  - [Nursery](#nursery)
   - [REST API Client](#rest-api-client)
-  - [GraphQL Client](#graphql-client)
+  - [Cuttings](#cuttings)
+  - [Nursery](#nursery)
   - [ESLint Plugin](#eslint-plugin)
 - [Contributing](#woman_technologist-contributing)
   - [Code of Conduct](#code-of-conduct)
@@ -77,15 +77,15 @@
     </td>
     <td>
       <h3><a href="./packages/cuttings/">Cuttings</a></h3>
-      <div>A library that creates JSON representations of Figma content (files, styles, etc.).</div>
+      <div><code role="status" aria-label="Work in progress">WIP</code> A library that creates JSON representations of Figma content (files, styles, etc.).</div>
     </td>
     <td>
       <h3><a href="./apps/nursery/">Nursery</a></h3>
-      <div>A library for fetching, storing and rehydrating cuttings automatically.</div>
+      <div><code role="status" aria-label="To do">TODO</code> A library for fetching, storing and rehydrating cuttings automatically.</div>
     </td>
     <td>
       <h3><a href="./packages/eslint-plugin-figma/">ESLint Plugin</a></h3>
-      <div>An ESLint plugin that can parse Figma cutting files and run rules against them.</div>
+      <div><code role="status" aria-label="To do">TODO</code> An ESLint plugin that can parse Figma cutting files and run rules against them.</div>
     </td>
   </tr>
 </table>

diff --git a/packages/rest/README.md b/packages/rest/README.md
@@ -100,7 +100,7 @@ An [OAuth2 token](https://www.figma.com/plugin-docs/oauth-with-plugins/) to auth
 
 #### personalAccessToken `string`
 
-An [Personal Access Token](https://help.figma.com/hc/en-us/articles/8085703771159-Manage-personal-access-tokens) to authenticate to the client. It is mandatory to either pass this token or an `oauthToken`.
+A [Personal Access Token](https://help.figma.com/hc/en-us/articles/8085703771159-Manage-personal-access-tokens) to authenticate to the client. It is mandatory to either pass this token or an `oauthToken`.
 
 #### cache `boolean | object`
 

diff --git a/packages/rest/package.json b/packages/rest/package.json
@@ -3,7 +3,7 @@
   "version": "0.0.0-semantically-released",
   "license": "MIT",
   "type": "module",
-  "description": "Fully-typed JS client for the Figma REST API",
+  "description": "TypeScript client for the Figma REST API with built-in cache and auto-retry. Always up-to-date.",
   "repository": {
     "type": "git",
     "url": "https://github.com/Sidnioulz/figmarine",
@@ -12,14 +12,7 @@
   "bugs": {
     "url": "https://github.com/Sidnioulz/figmarine/issues"
   },
-  "keywords": [
-    "figma",
-    "rest",
-    "api",
-    "openapi-specification",
-    "oas",
-    "figmarine" 
-  ],
+  "keywords": ["figma", "rest", "api", "openapi-specification", "oas", "figmarine"],
   "author": "Steve Dodier-Lazaro",
   "homepage": "https://github.com/Sidnioulz/figmarine",
   "scripts": {
@@ -51,9 +44,7 @@
       "default": "./dist/*.js"
     }
   },
-  "files": [
-    "dist/**"
-  ],
+  "files": ["dist/**"],
   "publishConfig": {
     "access": "public"
   },
@@ -88,4 +79,4 @@
     "axios-cache-interceptor": "^1.6.2",
     "axios-retry": "^4.5.0"
   }
-}
+}