aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJustin Bedo <cu@cua0.org>2021-08-02 21:41:57 +1000
committerJustin Bedo <cu@cua0.org>2021-08-02 21:49:50 +1000
commitefd9fcdbbd3a961e97bb3d02ae086c258c1ecb40 (patch)
treec478fc2bfa79e6383b6395c3a9eda1b53e1408b6 /README.md
initial implementation
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5beb087
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+A command line interface to clinvar.
+
+# Demo
+
+![demo](https://vk3.wtf/clinvar.gif)
+
+# Install
+
+It's just a script, there are dependencies on libxml2 and FZF. If you have
+Nix with flakes enabled you can run it without "installing" by
+```
+nix run git://vk3.wtf/clinvar.git search-terms ...
+```
+or put it into your active profile with
+```
+nix-env -i $(nix eval --raw git://vk3.wtf/clinvar.git)
+```
+
+
+# Contributing
+
+Email me with issues and patches.