From 9c7d5ae7847d65b783d79bce3b54d4030a10140c Mon Sep 17 00:00:00 2001
From: Chris Pecunies <clp@clp.is>
Date: Sat, 16 Nov 2024 00:10:14 -0800
Subject: [PATCH] add readme

---
 .github/workflows/luarocks.yml             | 1 -
 README.md                                  | 8 ++++++--
 flake.nix                                  | 2 +-
 lua/dorm/mod/{.lua => snippets/module.lua} | 0
 lua/dorm/mod/sync/module.lua               | 0
 scripts/test.sh                            | 0
 6 files changed, 7 insertions(+), 4 deletions(-)
 rename lua/dorm/mod/{.lua => snippets/module.lua} (100%)
 create mode 100644 lua/dorm/mod/sync/module.lua
 create mode 100644 scripts/test.sh

diff --git a/.github/workflows/luarocks.yml b/.github/workflows/luarocks.yml
index 86c9c05..06e6a72 100644
--- a/.github/workflows/luarocks.yml
+++ b/.github/workflows/luarocks.yml
@@ -22,7 +22,6 @@ jobs:
           test_interpreters: ""
           dependencies: |
             nvim-nio ~> 1.7
-            lua-utils.nvim == 1.0.2
             plenary.nvim == 0.1.4
             nui.nvim == 0.3.0
             pathlib.nvim ~> 2.2
diff --git a/README.md b/README.md
index 85be00c..e6d0d2a 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,13 @@
-# dorm - a _familiar_, organized future for neovim
+# dorm - the _familiar_, organized future for neovim
 
 <a href="https://neovim.io"> ![Neovim](https://img.shields.io/badge/Neovim%200.10+-brightgreen?style=for-the-badge) </a>
 <a href="/LICENSE"> ![License](https://img.shields.io/badge/license-GPL%20v3-brightgreen?style=for-the-badge)</a>
+---
+`for neovim 0.10+`
+
+[toc]
 
-## About
+## Introduction
 
 - **dorm** is a plugin meant to bring the awesome extensibility of emacs [org-mode] or [neorg] without needing to switch from the gold standard [markdown], or from the best editor [neovim].
 
diff --git a/flake.nix b/flake.nix
index c7a9a1c..0994cf5 100644
--- a/flake.nix
+++ b/flake.nix
@@ -1,5 +1,5 @@
 {
-  description = "A very basic flake";
+  description = "dorm.lua";
 
   inputs = {
     nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";
diff --git a/lua/dorm/mod/.lua b/lua/dorm/mod/snippets/module.lua
similarity index 100%
rename from lua/dorm/mod/.lua
rename to lua/dorm/mod/snippets/module.lua
diff --git a/lua/dorm/mod/sync/module.lua b/lua/dorm/mod/sync/module.lua
new file mode 100644
index 0000000..e69de29
diff --git a/scripts/test.sh b/scripts/test.sh
new file mode 100644
index 0000000..e69de29