luk3yx
/
lurkcoin-core
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.md

This commit is contained in:
luk3yx 2021-02-22 19:37:15 +13:00
parent c363356ee7
commit 8f46319323
1 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -3,12 +3,29 @@
This is the core code of the current release of
[lurkcoin](https://forum.minetest.net/viewtopic.php?f=9&t=22768).
## Dependencies
## Installation
[Go](https://golang.org) 1.13+
Make sure you have [Go](https://golang.org) 1.13 or later installed.
I advise against importing lurkcoin in your own Go code, any functions or types
can and will change in future releases.
To run lurkcoin, you can just install the lurkcoin-core binary:
```
$ go get github.com/luk3yx/lurkcoin-core
$ lurkcoin-core /path/to/config.yaml
```
*If you get a command not found error, you may have to run
~/go/bin/lurkcoin-core instead.*
I advise against importing `github.com/luk3yx/lurkcoin-core` in your own Go
code, any functions or types can and will change in future releases.
## Restoring the database from a backup
```
$ go get github.com/luk3yx/lurkcoin-core/cmd/...
$ lurkcoin-restore-backup /path/to/config.yaml /path/to/backup.json
```
## Configuration