diff --git a/README.md b/README.md index 50eefe8..9124c1c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,22 @@ # nas small go nas platform for my raspberry pi +## usage + +``` +cp assets/config/config.example.json assets/config/config.json + # edit config file with your hot/cold storage locations +nano assets/config/config.json +# run +go run webserver.go +# or build and run +go build; ./nas +``` + +you can also optionally use the `build-pi.sh` to build it for a raspberry pi (tested with raspberry pi 3 model b+) + +then navigate to `localhost:3000` + ## credits svg icons via https://iconsvg.xyz diff --git a/assets/config/config.example.json b/assets/config/config.example.json new file mode 100644 index 0000000..db55697 --- /dev/null +++ b/assets/config/config.example.json @@ -0,0 +1,4 @@ +{ + "ColdStorage": "", + "HotStorage": "" +} \ No newline at end of file