From f145adbc6024548cf8aa706cbb7930b7c890140e Mon Sep 17 00:00:00 2001
From: Chapman Pendery <35637443+cpendery@users.noreply.github.com>
Date: Mon, 18 Sep 2023 02:50:43 -0400
Subject: [PATCH] docs: add readme

---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6be83c1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+# clac
+
+clac provides IDE style autocomplete aka `inshellisense` in every shell
+
+https://github.com/cpendery/clac/assets/35637443/031599a2-5240-4b57-bcb1-a10ca8152b30
+
+clac is built on Fig's [autocomplete specs](https://github.com/withfig/autocomplete) which
+provide support for 600+ command line tools.
+
+## Supported Integrations
+
+| Shells             | IDEs               | Terminals       | OS      |
+| ------------------ | ------------------ | --------------- | ------- |
+| zsh                | Visual Studio Code | Terminal        | Mac     |
+| bash               | JetBrains Suite    | iTerm/iTerm2    | Windows |
+| pwsh (Powershell)  | Android Studio     | Hyper           | Linux   |
+| Windows Powershell |                    | Xterm.js & More |
+
+## Getting Started
+
+### Installation
+
+#### MacOS & Linux
+
+```shell
+go install github.com/cpendery/clac@latest
+```
+
+#### Windows
+
+```shell
+choco install clac
+```
+
+### Quickstart
+
+After completing the installation, bind `clac` to the terminal you'd like to use
+it with via the `clac bind [shell]` command. This will create a custom keybinding
+for `CTRL+a` to trigger the autocomplete session & execution.
+
+## Inspirations
+
+- [syft](https://github.com/anchore/syft) & [grype](https://github.com/anchore/grype)
+- [fig](https://github.com/withfig/autocomplete)
+- [warp](https://www.warp.dev/)
+- [fzf](https://github.com/junegunn/fzf)
+- [bubbletea](https://github.com/charmbracelet/bubbletea)