From 660abd73094b4e417464255f10534a4308ee7fbc Mon Sep 17 00:00:00 2001
From: Mihai Parparita <mihai@tailscale.com>
Date: Mon, 24 Oct 2022 13:38:47 -0700
Subject: [PATCH] cmd/tsconnect: add README to generated NPM package

Makes the landing page at https://www.npmjs.com/package/@tailscale/connect
look slightly nicer.

Fixes #5976

Signed-off-by: Mihai Parparita <mihai@tailscale.com>
---
 cmd/tsconnect/README.md     |  2 +-
 cmd/tsconnect/README.pkg.md |  3 +++
 cmd/tsconnect/build-pkg.go  | 14 +++++++++++++-
 3 files changed, 17 insertions(+), 2 deletions(-)
 create mode 100644 cmd/tsconnect/README.pkg.md

diff --git a/cmd/tsconnect/README.md b/cmd/tsconnect/README.md
index bb4dddfe6..ad1ff1115 100644
--- a/cmd/tsconnect/README.md
+++ b/cmd/tsconnect/README.md
@@ -31,7 +31,7 @@ By default the build output is placed in the `dist/` directory and embedded in t
 
 # Library / NPM Package
 
-The client is also available as an NPM package. To build it, run:
+The client is also available as [an NPM package](https://www.npmjs.com/package/@tailscale/connect). To build it, run:
 
 ```
 ./tool/go run ./cmd/tsconnect build-pkg
diff --git a/cmd/tsconnect/README.pkg.md b/cmd/tsconnect/README.pkg.md
new file mode 100644
index 000000000..df8d66789
--- /dev/null
+++ b/cmd/tsconnect/README.pkg.md
@@ -0,0 +1,3 @@
+# @tailscale/connect
+
+NPM package that contains a WebAssembly-based Tailscale client, see [the `cmd/tsconnect` directory in the tailscale repo](https://github.com/tailscale/tailscale/tree/main/cmd/tsconnect#library--npm-package) for more details.
diff --git a/cmd/tsconnect/build-pkg.go b/cmd/tsconnect/build-pkg.go
index 8b0b6a79b..3942260c7 100644
--- a/cmd/tsconnect/build-pkg.go
+++ b/cmd/tsconnect/build-pkg.go
@@ -27,7 +27,7 @@ func runBuildPkg() {
 		log.Fatalf("Linting failed: %v", err)
 	}
 
-	if err := cleanDir(*pkgDir, "package.json"); err != nil {
+	if err := cleanDir(*pkgDir); err != nil {
 		log.Fatalf("Cannot clean %s: %v", *pkgDir, err)
 	}
 
@@ -51,6 +51,10 @@ func runBuildPkg() {
 		log.Fatalf("Cannot update version: %v", err)
 	}
 
+	if err := copyReadme(); err != nil {
+		log.Fatalf("Cannot copy readme: %v", err)
+	}
+
 	log.Printf("Built package version %s", version.Long)
 }
 
@@ -84,3 +88,11 @@ func updateVersion() error {
 
 	return os.WriteFile(path.Join(*pkgDir, "package.json"), packageJSONBytes, 0644)
 }
+
+func copyReadme() error {
+	readmeBytes, err := os.ReadFile("README.pkg.md")
+	if err != nil {
+		return fmt.Errorf("Could not read README.pkg.md: %w", err)
+	}
+	return os.WriteFile(path.Join(*pkgDir, "README.md"), readmeBytes, 0644)
+}