From d4eab703872fa25245743b341878288f757edead Mon Sep 17 00:00:00 2001 From: Chris Duncan Date: Sun, 12 Jan 2025 15:41:43 -0800 Subject: [PATCH] Expand on build steps. --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c0d1ac4..9318dbe 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,6 @@ proof-of-work equation defined by Nano, see https://docs.nano.org/integration-guides/work-generation/#work-calculation-details ## Installation - ```console npm i nano-pow ``` @@ -49,8 +48,8 @@ Any of these options can also be imported into the global namespace by targeting console.log(NanoPow) ``` -### Search +### Search ```javascript // `hash` is a 64-char hex string const hash = '0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef' @@ -60,7 +59,6 @@ const work = await NanoPow.search(hash, threshold) ``` ### Validate - ```javascript // `work` is a 16-char hex string const work = 'fedcba0987654321' @@ -102,7 +100,17 @@ performance out of it. speed of this tool. Feel free to check out how your system fares. ## Building -* `npm run build` Compile TypeScript, then minify and bundle with esbuild +1. Clone source +1. Enter the directory +1. Install dev dependencies +1. Compile, minify, and bundle + +```bash +git clone https://zoso.dev/nano-pow.git +cd nano-pow +npm i +npm run build +``` ## Donations If you find this package helpful, please consider tipping the developer. -- 2.34.1