summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..33c04f3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+ghligh
+======
+
+ghligh can be used to manipulate pdf files in various ways.
+
+### Usage:
+- ghligh [flags]
+- ghligh [command]
+
+### Available Commands:
+- `cat` cat shows highlights pdf files
+- `completion` Generate the autocompletion script for the specified shell
+- `export` export pdf highlights into json
+- `hash` display the ghligh hash used to identify a documet [json]
+- `help` Help about any command
+- `import` import highlights from json file
+- `info` display info about pdf documents [json]
+- `ls` show files with highlights or tagged with 'ls' [unix]
+- `tag` manage pdf tags
+
+
+### Flags:
+ -h, --help help for ghligh
+
+Use `ghligh [command] --help` for more information about a command.