From f949689b4d56daa9988c821e2f0e1b470cfc7275 Mon Sep 17 00:00:00 2001
From: JP Appel <jeanpierre.appel01@gmail.com>
Date: Wed, 23 Jul 2025 02:07:08 -0400
Subject: Update help info

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 5303ee1..33417cb 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,49 @@
 # Atlas
 
 A tool for querying markdown files with YAML metadata.
+
+## Build
+
+```bash
+make
+```
+
+### Install
+
+Default installation path is `$HOME/.local/bin`
+
+```bash
+make install
+```
+
+## Usage
+
+```
+atlas is a note indexing and querying tool
+
+Usage:
+  atlas [global-flags] <command>
+
+Commands:
+  index <subcommand>    - build, update, or modify an index
+  query <subcommand>    - search against an index
+  shell                 - start a debug shell
+  server                - start an http query server (EXPERIMENTAL)
+  help  <help-topic>    - print help info
+
+Global Flags:
+  -dateFormat format
+    	format for dates (see https://pkg.go.dev/time#Layout for more details) (default "2006-01-02T15:04:05Z07:00")
+  -db path
+    	path to document database (default "/home/goose/.local/share/atlas/default.db")
+  -logFile file
+    	file to log errors to, use '-' for stdout and empty for stderr
+  -logJson
+    	log to json
+  -logLevel level
+    	set log level (debug, info, warn, error) (default "error")
+  -numWorkers uint
+    	number of worker threads to use (defaults to core count) (default 4)
+  -root directory
+    	root directory for indexing (default "/home/goose/doc")
+```
-- 
cgit v1.2.3