docs: make executable binaries

starikcetin · Jun 25, 2023 · 3038f14 · 3038f14
1 parent 981ecd9
commit 3038f14
Show file tree

Hide file tree

Showing 5 changed files with 689 additions and 8 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,7 @@
-node_modules
-dist
+node_modules/
+src/generated/
+dist/
+bin/
 yarn-error.log
 .vscode
-*.tsbuildinfo
-src/generated/
+*.tsbuildinfo
diff --git a/README.md b/README.md
@@ -4,15 +4,25 @@ A git-based locking mechanism for Unity CCD bucket operations. Can be used to pr
 
 ## Requirements
 
-- Node.js version `8.0.0` or higher.
+- Node.js version `8.0.0` or higher _(not needed for executable binaries)_.
 - You have Git installed and it is in your PATH.
 
 ## Installation
 
+### Install via npm
+
 ```sh
 npm i -g unity-ccd-locker
 ```
 
+You can use `yarn` etc. as well.
+
+### Download an executable binary
+
+Executable binaries are available for Windows, Mac, and Linux. You don't anything except git installed on your system to use them.
+
+You can download them from the assets section of a [Github release](https://github.com/starikcetin/unity-ccd-locker/releases).
+
 ## Usage
 
 ```