TigerFetch.jl

commit 9751cf2675ea95fe6ef14ad441df68340fa70c48
parent 4c0920f94862f390546293ef1ddf3ad49c4b4c5f
Author: Erik Loualiche <eloualic@umn.edu>
Date:   Sun, 23 Feb 2025 09:56:21 -0600

basic readme

Diffstat:
M
README.md
 | 
17
++++++++++++++++-

1 file changed, 16 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -1,3 +1,18 @@
 # TigerFetch
 
-[![Build Status](https://github.com/eloualiche/TigerFetch.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/eloualiche/TigerFetch.jl/actions/workflows/CI.yml?query=branch%3Amain)
+Install the command line tool (you need a julia installation for this)
+```bash
+julia --project deps/build.jl install
+```
+
+The binary will available at `~/.julia/bin/tigerfetch`.
+You can use it 
+```bash
+~/.julia/bin/tigerfetch --help
+~/.julia/bin/tigerfetch state
+~/.julia/bin/tigerfetch cousub --state IL
+~/.julia/bin/tigerfetch areawater --state "Minnesota" # 10,000 lakes
+~/.julia/bin/tigerfetch areawater --state "Minnesota" --county "Hennepin" 
+```
+
+