docs: define non-goals

chrisgrieser · Sep 20, 2023 · 0a0b688 · 0a0b688
1 parent d2d13c1
commit 0a0b688
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -21,11 +21,5 @@ body:
       options:
         - label: The feature would be useful to more users than just me.
           required: true
-        - label: I understand that this plugin does not intend to be a full-blown git client like Neogit.
-          required: true
-        - label: The feature is not available via gitsigns.nvim.
-          required: true
-        - label: >
-            The request does not concern the appearance of the commit message input field.
-            (Which is controlled via dressing.nvim and not this plugin.)
+        - label: I have read the [Non-Goals section of the README](./README.md#non-goals).
           required: true
diff --git a/README.md b/README.md
@@ -13,6 +13,7 @@ Lightweight and nimble git client for nvim.
 - [Installation](#installation)
 - [Usage](#usage)
 - [Configuration](#configuration)
+- [Non-Goals](#non-goals)
 - [Credits](#credits)
 <!--toc:end-->
 
@@ -23,7 +24,6 @@ Lightweight and nimble git client for nvim.
 - Quick amends.
 - Search issues & PRs. Open the selected issue or PR in the browser.
 - Open the GitHub URL of the current file or selection.
-- Non-Goal: Become [neogit](https://github.com/TimUntersberger/neogit) or [gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim). `tinygit` is intended to complement those plugins with some simple commands, not replace them.
 
 ## Installation
 
@@ -111,7 +111,13 @@ local defaultConfig = {
 }
 ```
 
-To change the appearance and behavior of the commit message input field, you need to configure [dressing.nvim](https://github.com/stevearc/dressing.nvim).
+> [!NOTE]
+> To change the appearance and behavior of the commit message input field, you need to configure [dressing.nvim](https://github.com/stevearc/dressing.nvim).
+
+## Non-Goals
+- Become a full-fledged git client. Use [neogit](https://github.com/NeogitOrg/neogit) for that.
+- Add features available in [gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim). `tinygit` is intended to complement `gitsigns.nvim` with some simple commands, not replace it.
+- UI Customization. Configure [dressing.nvim](https://github.com/stevearc/dressing.nvim) for that.
 
 ## Credits
 __About Me__