]> zoso.dev Git - nano-pow.git/commitdiff
Expand on build steps.
authorChris Duncan <chris@zoso.dev>
Sun, 12 Jan 2025 23:41:43 +0000 (15:41 -0800)
committerChris Duncan <chris@zoso.dev>
Sun, 12 Jan 2025 23:41:43 +0000 (15:41 -0800)
README.md

index c0d1ac44bf2796a12de2c42a8c5a65d8e81440ce..9318dbe81e53ebacce5122aea3f37f48cecd9b19 100644 (file)
--- 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)
 </script>
 ```
-### 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.