Merge pull request #2 from flotiq/feature/update-readme

add plugin information to the readme and update description

Author: rgembalik

.docs/images/custom_link_plugin.png

@@ -1,6 +1,26 @@
-[[_TOC_]]
+# About plugin
 
-# Custom Links Plugin
+This plugin will display a button with a link in the content edit object. The link will be supplemented with data from the currently edited object. Thanks to this link, you will be able to easily access the preview of where the content will be used.
+
+## Plugin outcome
+
+In the sidebar of the Content Object form, you will see a panel with the configured link button. The button will not be visible when adding a new object.
+
+<img src=".docs/images/custom_link_plugin.png" alt="plugin-item" width="1000"/>
+
+## Configuring plugin
+
+To manage a plugin, you must first add it to your plugins. Click the "+" icon to add the plugin to your library and click the "Manage" button. It will open the plugin settings.
+
+<img src=".docs/images/custom_link_settings.png" alt="plugin-settings" width="700"/>
+
+Field descriptions: 
+
+* `URL Template` - It's a place to enter the link template, e.g. https://my-blog/post/{slug}, where `slug` is the name of the content field of the type selected below. Instead of `{slug}`, you can use any field of a given content type, it is also possible to use nesting, e.g. `{internal.createdAt}`. You can also use list fields: `{addresses[0].city}`.
+* `Displayed Name Template` - Any name that will be displayed on the link button. You can also use content object fields (e.g. `{slug}`), in the same way as with Url Template.
+* `Content Type Definition` - Select the content type to display the button only for the specified content type. If the content type is not selected, the button will be shown when editing each content object.
+
+# Development
 
 ## Quick start
 

.docs/images/custom_link_settings.png

@@ -1,8 +1,8 @@
 {
   "id": "flotiq.custom-links",
   "name": "Custom Links",
-  "version": "1.0.0",
-  "description": "This plugin allows to create custom links in each entity view.",
+  "version": "1.0.1",
+  "description": "This plugin will display a button with a link in the edit content object. The link will be supplemented with data from the currently edited object. Thanks to this link, you will be able to get easy access to the preview of where the content is used.",
   "repository": "https://github.com/flotiq/flotiq-ui-plugins-custom-links",
   "url": "https://localhost:3053/index.js",
   "permissions": [