From 15b673958676ccded493bb726d738fd22b1a318b Mon Sep 17 00:00:00 2001
From: mars <mars@tebibyte.media>
Date: Sat, 29 Apr 2023 19:34:32 -0400
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2b4a3c6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Breed
+
+Breed is a minimalistic modal editor inspired by Helix, but hopefully without
+all of the extra junk I don't care about.
+
+It would be really neat for it to support LSP, Treesitter, and kakoune-like
+client-server operation.
+
+# To-Do List
+
+- [ ] detect correct syntax from file info
+- [ ] word and WORD navigation
+- [ ] config file
+- [ ] keybind modifiers
+- [ ] better submode key rendering
+- [ ] tab insertion
+- [ ] treesitter support
+- [ ] LSP support
+- [ ] keybind configuration
+- [ ] page up and page down
+- [ ] selection/visual mode
+- [ ] multicursor
+- [ ] command callbacks
+- [ ] configurable autoscroll margins
+- [ ] configurable newline hide
+- [ ] `:theme`
+- [ ] copy/cut/paste
+- [ ] mouse input
+- [ ] theme style modifiers
+- [ ] configurable indents
+- [ ] client/server with UDS socket