diff --git a/README.md b/README.md index f517e45..76c4652 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,34 @@ -# Tx elm +# tx-elm -> Subbit.xyz tx builder using elm-cardano +Exploration of elm and elm-cardano with view of tx building for Subbit.xyz and +others. ## Setup -This repo is using nix flakes. +### Dev env -The "right" way to package elm with nix is not known to the author. +This repo is using nix flakes and has a devshell. Otherwise dependencies are +`elm`, `nodejs` and `just`. -- Maybe [elm2nix](https://github.com/cachix/elm2nix) +The "right" way to package elm with nix is not known to the author. Maybe +[elm2nix](https://github.com/cachix/elm2nix). But we can revisit this later. -## CLi +### Install -The way elm works seems to be rather sneaky. It adds `Elm` to the global js -scope. In typical use this is then picked up by some script embedded in the page -: +Using `just`, `just setup` -```js - var app = Elm.Main.init({ node: document.getElementById("elm"), flags : ... }); +### Build & Run + +``` + just dev ``` -Instead we want to call it with node. Appending the output file with +## Todo -```js -this.Elm.Cli.init({ flags: process.argv }); -``` - -Does the job. But there must be a better way ... +- [ ] L1 provider interface +- [ ] Pretty print json to stdout +- [ ] Read env vars +- [ ] Read and write files +- [ ] Use model to iterate on state +- [ ] Use wallet +- [ ] Tx builder interface