fix: adapt for @octoherd/cli v3 (#31)

Author: gr2m

lib/create-readme.js

@@ -17,17 +17,17 @@ export default async function createReadme({
 
   if (addWip) {
     // WIP banner
-    content += `# 🚧 WORK IN PROGRESS. See [#1](https://github.com/${repository}/pull/1)
+    content += `# 🚧 WORK IN PROGRESS. See [#1](https://github.com/${repository}/pull/1) | [Preview](https://github.com/${repository}/tree/initial-version)
 
 `;
   }
 
   // header
-  content += `# ${repo}
+  content += `# ${repo}\n\n`;
 
-> ${description}
-
-`;
+  if (description) {
+    content += `> ${description}\n\n`;
+  }
 
   if (addBadges) {
     content += `[![@latest](https://img.shields.io/npm/v/${packageName}.svg)](https://www.npmjs.com/package/${packageName})
@@ -37,58 +37,69 @@ export default async function createReadme({
   }
 
   if (addUsage) {
-    let usage = `npx ${packageName} \\
-  --octoherd-token 0123456789012345678901234567890123456789 \\
-  "${owner}/*"`;
+    let minimalUsage = `npx ${packageName}`;
+    let fullUsage = `npx ${packageName} \\
+  -T ghp_0123456789abcdefghjklmnopqrstuvwxyzA \\
+  -R "${owner}/*"`;
 
     Object.entries(scriptOptions).forEach(([name, { required, example }]) => {
       if (!required) return;
-      usage += ` \\
+      minimalUsage += ` \\
+  --${name} ${example}`;
+    });
+    Object.entries(scriptOptions).forEach(([name, { required, example }]) => {
+      fullUsage += ` \\
   --${name} ${example}`;
     });
 
     content += `## Usage
 
+Minimal usage
+
 \`\`\`js
-${usage}
+${minimalUsage}
+\`\`\`
+
+Pass all options as CLI flags to avoid user prompts
+
+\`\`\`js
+${fullUsage}
 \`\`\`
 
-`;
 
-    if (Object.keys(scriptOptions).length === 0) {
-      content += `The script has no options
-      
 `;
-    } else {
-      content += `## Options
+
+    content += `## Options
       
 | option | type | description |
 | --- | --- | --- |
 `;
 
-      Object.entries(scriptOptions).forEach(
-        ([name, { type, required, description, default: defaultValue }]) => {
-          const CliOption = decamelize(name, {
-            separator: "-",
-          });
-          let optionNames = `\`--${CliOption}\``;
-          if (type === "boolean") {
-            optionNames += ` or \`--no-${CliOption}\``;
-          }
-
-          content += `| ${optionNames} | ${type} | ${
-            required ? `**(required)**` : ""
-          } ${description} ${
-            defaultValue
-              ? `. Defaults to ${
-                  type === "string" ? `"${defaultValue}"` : defaultValue
-                }`
-              : ""
-          } |
-`;
+    Object.entries(scriptOptions).forEach(
+      ([name, { type, required, description, default: defaultValue }]) => {
+        const CliOption = decamelize(name, {
+          separator: "-",
+        });
+        let optionNames = `\`--${CliOption}\``;
+        if (type === "boolean") {
+          optionNames += ` or \`--no-${CliOption}\``;
         }
-      );
-    }
+
+        content += `| ${optionNames} | ${type} | ${
+          required ? `**Required.**` : ""
+        } ${description}${
+          defaultValue
+            ? `. Defaults to ${
+                type === "string" ? `"${defaultValue}"` : defaultValue
+              }`
+            : ""
+        } |
+`;
+      }
+    );
+
+    content += `| \`--octoherd-token\`, \`-T\` | string | A personal access token ([create](https://github.com/settings/tokens/new?scopes=repo)). Script will create one if option is not set |\n`;
+    content += `| \`--octoherd-repos\`, \`-R\` | array of strings | One or multiple space-separated repositories in the form of \`repo-owner/repo-name\`. \`repo-owner/*\` will find all repositories for one owner. \`*\` will find all repositories the user has access to. Will prompt for repositories if not set |\n\n`;
   }
 
   // footer