From c4f992a3b60d1827c68f9e3bab7e18f3c679679d Mon Sep 17 00:00:00 2001
From: Daniil Rozanov <daniilrozzanov@gmail.com>
Date: Sat, 4 May 2024 00:43:25 +0300
Subject: docs: update README.md

---
 README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 80f9ca5..426cb32 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,24 @@
-# cmake-overseer.nvim
+# cmake.nvim
+
+This plugin allows you to make work with the CMake pipeline more automated. In fact, it creates Vim
+commands as dynamic aliases for cmake commands for generating, building, running, testing (WIP),
+installing (WIP) and packaging (WIP) a project.
+
+In addition, it provides a way to navigate through the project in terms of CMake, for example, displaying a list
+of targets, projects, directories and entities dependent on them (WIP).
+
+## TODO
+
+- [ ] Support CMake Presets
+- [ ] Docs and help pages
+- [ ] API for other plugins to interact with internal processes
+- [ ] CMake settings per project (`cmake-settings.yaml`)
+- [ ] Support more substitutions in `build_directory`
+- [ ] Intergation with Telescope to list
+  - targets
+  - projects
+  - directories
+  - installers
+  - ...
+
+  and go to it's definitions, depentent target and other possible entities in any meaningful relations
-- 
cgit v1.2.3