From 7c0ef86eaea0e4e31680ab439f45d3435ed35c4e Mon Sep 17 00:00:00 2001
From: Christian Segundo
Date: Sun, 8 Dec 2024 12:37:56 +0100
Subject: move readme and preview to wiki

---
 README.md | 38 --------------------------------------
 1 file changed, 38 deletions(-)
 delete mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
deleted file mode 100644
index 007de42..0000000
--- a/README.md
+++ /dev/null
@@ -1,38 +0,0 @@
-# cmp-abook
-
-A completion source for [nvim-cmp][nvim-cmp] that provides sources for addresses
-in [Abook][abook] when writing emails.
-
-![](preview.gif)
-
-## Dependencies
-
-- [plenary.nvim][plenary.nvim]
-
-## Setup
-
-Just add the `abook` source to [nvim-cmp][nvim-cmp] setup call:
-
-``` lua
-sources = {
-    -- Most names in an address book have spaces in them. However, cmp restarts
-    -- the completion after a space. The `space_filter` option is a way to get
-    -- around this by using a different character to represent spaces.
-    { name = "abook", option = { space_filter = "-" } }
-}
-```
-
-### Multiple addressbooks
-
-By default the plugin uses the default addressbook. You can use the
-`ABOOK_ADDRESSBOOK` environment variable option to control which addressbook to
-use. If you're using `mutt` for email, you could set it like this:
-
-```
-set editor="ABOOK_ADDRESSBOOK='$HOME/.config/abook/my_custom_addressbook' nvim ...other options... %s"
-```
-
----
-[plenary.nvim]: https://github.com/nvim-lua/plenary.nvim
-[abook]: https://abook.sourceforge.io/
-[nvim-cmp]: https://github.com/hrsh7th/nvim-cmp
-- 
cgit v1.2.3