diff --git a/README.md b/README.md index d67b101..0b5a3b8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,34 @@ # Anchiale +## About + **Anchiale was the Titan goddess of the warming heat of fire.** ---- +Anchiale is an internet of things solution for temperature sampling with raspberry pi. It is designed around a scalable architecture, so it is capable of handling a big sample rate. + +## Installation + +**Run Locally** + +Clone the project: + + git clone git@github.com:xrazis/Anchiale-pi.git + +NPM install + + npm install --prefix ./client + npm install --prefix ./server + +## Development mode + +Running the server + + npm run dev prefix ./server + +Running the client + + npm run dev prefix ./client + +You can span as many clients as you want! -## +## Run in Docker