feat: Add more documentation
This commit is contained in:
15
README.md
15
README.md
@@ -8,3 +8,18 @@ Import this URL:
|
|||||||
```
|
```
|
||||||
https://git.woodburn.au/nathanwoodburn/hns-address-plugin.git
|
https://git.woodburn.au/nathanwoodburn/hns-address-plugin.git
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|

|
||||||
|
|
||||||
|
### Generate
|
||||||
|
Enter the number of addresses you want to generate and click Generate
|
||||||
|
Note that you don't need to fill the fields as the default values will be used. This also creates a file in user_data with the result to allow easier copying
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Validate
|
||||||
|
Enter the address you want to validate and click Validate
|
||||||
|
Note that you don't need to fill the xPub field
|
||||||
|
|
||||||
|

|
||||||
BIN
assets/dash.png
Normal file
BIN
assets/dash.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 52 KiB |
BIN
assets/generate.png
Normal file
BIN
assets/generate.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 122 KiB |
BIN
assets/validate.png
Normal file
BIN
assets/validate.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 51 KiB |
@@ -113,7 +113,7 @@ def generate(params, authentication):
|
|||||||
return {"result": "No xpub found"}
|
return {"result": "No xpub found"}
|
||||||
|
|
||||||
result = subprocess.run(["node", "generate-address.js", "--xpub", xpub, "--number", str(count), "--startIndex", str(startIndex)], capture_output=True, text=True, cwd=hnsAddressPath)
|
result = subprocess.run(["node", "generate-address.js", "--xpub", xpub, "--number", str(count), "--startIndex", str(startIndex)], capture_output=True, text=True, cwd=hnsAddressPath)
|
||||||
with open(f"{xpub}-addresses.txt", "w") as f:
|
with open(f"user_data/{xpub}-addresses.txt", "w") as f:
|
||||||
f.write(result.stdout)
|
f.write(result.stdout)
|
||||||
|
|
||||||
return {"result": result.stdout.split("\n")[2:-1]}
|
return {"result": result.stdout.split("\n")[2:-1]}
|
||||||
|
|||||||
Reference in New Issue
Block a user