aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b52c781
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Hobs.nvim
+
+In English and in broader Northern European folklore a hob (short for hobgoblin)
+is a type of small household spirit. Hobs are often portrayed as helpful,
+domestic beings which quietly assist with chores around the house in exchange
+for small offerings or simply out of habit.
+
+In this project, the name is used metaphorically: small, invisible workers that
+live inside your editor, quietly helping with tasks while you continue your own
+work.
+
+## Little AI Helpers Which Work Along Side You In Neovim
+
+Most coding agents today follow a serial workflow. Typically something like:
+
+1. Human requests the AI do something
+1. The AI takes control of the repository
+1. Human waits for the AI to finish
+1. AI finishes and returns control of the repository.
+1. Human continues with the work
+
+`hobs.nvim` makes this flow concurrent. Now, the human can request an AI agent
+(A "hob"). The hob can do some simple task in the background, updating the live
+buffer as it goes along all while the human continues with his work.