X-Git-Url: http://www.aleph1.co.uk/gitweb/?a=blobdiff_plain;f=web%2Fmodules%2Fcontrib%2Flinkit%2FREADME.md;fp=web%2Fmodules%2Fcontrib%2Flinkit%2FREADME.md;h=7f610ba715e601fd214aba07807fce8a155114f3;hb=a2bd1bf0c2c1f1a17d188f4dc0726a45494cefae;hp=0000000000000000000000000000000000000000;hpb=57c063afa3f66b07c4bbddc2d6129a96d90f0aad;p=yaffs-website

diff --git a/web/modules/contrib/linkit/README.md b/web/modules/contrib/linkit/README.md
new file mode 100644
index 000000000..7f610ba71
--- /dev/null
+++ b/web/modules/contrib/linkit/README.md
@@ -0,0 +1,33 @@
+Linkit
+===========
+Linkit provides an **enriched linking experience for internal and external
+linking** with editors by using an autocomplete field. Linkit has by default
+support for nodes, users, taxonomy terms, files, comments and
+**basic support for all types of entities** that defines a canonical link
+template.
+
+
+Installation
+------------
+
+* Normal module installation procedure. See
+  https://www.drupal.org/documentation/install/modules-themes/modules-8
+
+
+Configuration
+------------
+
+After the installation, you have to create a Linkit profile. The profile will
+contain information about which plugins to use.
+Profiles can be created at `/admin/config/content/linkit`
+
+When you have created a profile, you need to enable the Linkit plugin on the
+text format you want to use. Formats are found at
+`admin/config/content/formats`.
+
+
+Plugins examples
+------------
+
+There are plugin implementation examples in the linkit_test module bundled with
+Linkit core.