add readme

clpi · Nov 16, 2024 · 9c7d5ae · 9c7d5ae
1 parent e0ad7a7
commit 9c7d5ae
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 4 deletions.
diff --git 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
@@ -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
@@ -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 → lua/dorm/mod/snippets/module.lua b/lua/dorm/mod/.lua → lua/dorm/mod/snippets/module.lua
diff --git a/lua/dorm/mod/sync/module.lua b/lua/dorm/mod/sync/module.lua
diff --git a/scripts/test.sh b/scripts/test.sh