diff --git a/README.md b/README.md index c8b99ea..f4b5632 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # kennson A terminal utility to pretty print JSON. + +![Screenshot showing kennson pretty printing a JSON file](screenshot.png) + +## Build instructions + +Make sure you have [Dart](https://dart.dev/get-dart) installed, then run the following: + +```bash +dart compile exe bin/kennson.dart +``` + +The compiled executable will be inside the `bin` folder, named `kennson.exe` (regardless of platform). diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..0093c5d Binary files /dev/null and b/screenshot.png differ