tools: add pkg install instruction tpl

thi-ng · Apr 28, 2020 · bc3ca84 · bc3ca84
1 parent 20ce586
commit bc3ca84
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/tools/src/partials/package.ts b/tools/src/partials/package.ts
@@ -84,3 +84,15 @@ export const packageBanner = (name: string) => {
         .substr(0, 8);
     return `![${name}](${CONFIG.bannerURL}${name}.svg?${sha1})`;
 };
+
+export const packageInstallation = (pkg: Package) => `\`\`\`bash
+yarn add ${pkg.name}
+\`\`\`
+
+\`\`\`html
+// ES module
+<script type="module" src="https://unpkg.com/${pkg.name}?module" crossorigin></script>
+
+// UMD
+<script src="https://unpkg.com/${pkg.name}/lib/index.umd.js" crossorigin></script>
+\`\`\``;
diff --git a/tools/src/readme.ts b/tools/src/readme.ts
@@ -11,6 +11,7 @@ import {
     packageBanner,
     packageDeps,
     packageDesc,
+    packageInstallation,
     packageSize,
     packageStatus,
     relatedPackages,
@@ -24,10 +25,12 @@ try {
 
     const partials: IObjectOf<string | Fn0<Nullable<string>>> = {
         "pkg.name": CONFIG.root.name,
+        "pkg.version": CONFIG.root.version,
         "pkg.description": () => packageDesc(CONFIG.root),
         "pkg.deps": () => packageDeps(CONFIG.root),
         "pkg.size": packageSize,
         "pkg.banner": () => packageBanner(CONFIG.root.name),
+        "pkg.install": () => packageInstallation(CONFIG.root),
         status: () => packageStatus(CONFIG.meta.status),
         examples: () => examplesTable(CONFIG.root.name),
         supportPackages: () => supportPackages(CONFIG.root.name),