aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoris2021-05-13 14:50:51 +0200
committerJoris2021-05-13 14:58:26 +0200
commit221b6451fb4f8559a10e7fefebd13ce125ef29d0 (patch)
tree3ab337b7b2d40e8235f887046a580b0850540f11 /README.md
parent5c636f11cdfed82634ee572645d765b704941b68 (diff)
Rewrite in TypeScript
BuckleScript is no longer maintained. Choose a widely used techno that will still be maintained in the following years.
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 5 insertions, 25 deletions
diff --git a/README.md b/README.md
index f1d9c26..9f5b91f 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,9 @@
-# Tabata timer
+# Getting started
-Available at [https://guyonvarch.gitlab.io/tabata-timer](https://guyonvarch.gitlab.io/tabata-timer).
+Run:
-## Gettings started
-
-Start the environment with:
-
-```bash
-./dev start
-```
-
-Later, stop the environment with:
-
-```bash
-./dev stop
+```sh
+nix-shell --run bin/watch.sh
```
-## Deploy
-
-```bash
-nix-shell --run ./deploy
-```
-
-## Bucklescript links
-
-- [Documentation](https://bucklescript.github.io/docs/en/interop-overview)
-- [Ocaml std API](https://caml.inria.fr/pub/docs/manual-ocaml-4.02/stdlib.html)
-- [Libraries](https://bucklescript.github.io/bucklescript/api/index.html)
+Then, open your browser at `http://localhost:8000`.