add note about badkeys, fix license path in build

runZeroInc · Aug 13, 2024 · 159a8cf · 159a8cf
1 parent e8e861d
commit 159a8cf
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -31,7 +31,7 @@ jobs:
           fetch-depth: 0
       - name: Build binary
         run: |
-          cp LICENSE "$RUNNER_TEMP/LICENSE"
+          cp LICENSE.md "$RUNNER_TEMP/LICENSE.md"
           VERSION="$(git describe --tags)"
           DIR="$(mktemp -d)"
           mkdir "$DIR/sshamble"

diff --git a/README.md b/README.md
@@ -38,6 +38,15 @@ $ cd sshamble
 $ go build -o sshamble
 ```
 
+To enable experimental [badkeys](https://badkeys.info) support, run the generator first:
+```shell
+$ git clone https://github.com/runZeroInc/sshamble
+$ cd sshamble
+$ go generate ./...
+$ go build -o sshamble
+```
+
+
 ## Usage
 
 ```