diff --git a/README.md b/README.md index cf98e6d..cf9296b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ # brisk -Freeze and thaw with Nippy at the command line + +Freeze and thaw with [Nippy](https://github.com/ptaoussanis/nippy) at the command line. + +# Install + +Download the latest from the [releases page](https://github.com/justone/brisk/releases). + +# Usage + +Freeze data: + +``` +brisk --freeze -i data.edn -o data.nippy +``` + +Thaw data: + +``` +brisk --thaw -i data.nippy -o data.edn +``` + +If input or output is not specified, stdin or stdout will be used: + +``` +cat data.edn | brisk -f | brisk -t > data2.edn +``` + +# To Do + +* [Babashka pod](https://github.com/babashka/babashka.pods) support, exposing nippy functions. + +# Things that don't work + +* Embedded objects - Nippy can handle them, but Graal VM does not support them.