From d49ea4337418ad21015651a8e021f912b9a3bc7f Mon Sep 17 00:00:00 2001
From: Nathan Reiner <nathan@nathanreiner.xyz>
Date: Thu, 6 Jul 2023 12:55:09 +0200
Subject: update readme

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

diff --git a/README.md b/README.md
index cbd86bd..fb51deb 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,38 @@
 
 A project to index all files in a subdirectory to make
 their contents searchable in a fast manner.
+
+The following filetypes are currently supported:
+- Raw Text File              (.txt)
+- Word                       (.docx)
+- PowerPoint                 (.pptx)
+- Excel                      (.xlsx)
+- Open Document Text         (.odt)
+- Open Document Presentation (.odp)
+- PDF                        (.pdf)
+
+## Building from Souce
+
+Just clone the repository and build it with `cargo`:
+
+```sh
+$ git clone https://git.nathanreiner.xyz/indexsearch
+$ cd indexsearch
+$ cargo build --release
+```
+
+The binary can be found under `./target/release/indexsearch`
+
+## How to Index A directory
+
+To generate a use the `-g` flag:
+
+```sh
+$ indexsearch -g index.idxs /path/to/directory
+```
+
+## Using the Index
+
+```sh
+$ indexsearch -s index.idxs word1 word2 ...
+```
-- 
cgit v1.2.3-70-g09d2