aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 11 insertions, 7 deletions
diff --git a/README.md b/README.md
index b1f3d7f..8fa35d1 100644
--- a/README.md
+++ b/README.md
@@ -2,24 +2,28 @@
Share costs with a group of people.
-## Usage
+## Required dependencies
+
+- `cabal2nix`
+- `nix-shell`
+- `cabal-install`
+- `npm`
+- `elm
-Install the nix package manager and get `cabal-install` and `cabal2nix`.
+## Usage
```
cabal2nix --shell . > shell.nix
nix-shell -I ~ --command 'cabal configure'
npm install
-npm run elm-install
+elm package install
npm start
```
## Configuration
-Here is an example configuration file:
-
```
-hostname = localhost:3001
-port = 3001
+hostname = localhost:3000
+port = 3000
currency = €
```