add readme

This commit is contained in:
2022-10-13 01:39:04 +02:00
parent 4711025fdb
commit d352cd346b

24
README.md Normal file
View File

@@ -0,0 +1,24 @@
# usage
works with node2nix. very simple
## reconfigure node packages
updates nix files depending on package.json
``` shell
node2nix
```
## build
``` shell
nix-build -A package
```
## run
``` shell
#run the executable
./result/bin/EvidenceDump
#run jusing node
node result/lib/node_modules/EvidenceDump/server.js
```