Merge pull request #3 from flotiq/feature/24764-update-readme

add information about plugin to readme and update description

Author: rgembalik

.docs/images/app_url.png

@@ -1,6 +1,33 @@
-[[_TOC_]]
+# About plugin
 
-# Deploy Netlify Plugin
+Netlify is the platform for building highly-performant and dynamic websites, e-commerce stores and web applications. With this plugin, you can easily trigger Netlify builds within Content Object changes on form submission. You will also be able to quickly navigate to your Netlify pages from the Flotiq content editor.
+
+## Plugin outcome
+
+In the sidebar of the Content Object form, you will see a panel with the Netlify build buttons. Once you click the button, a link to preview the page will appear below the button.
+
+<img src=".docs/images/netlify_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/netlify_settings.png" alt="plugin-settings" width="700"/>
+
+To complete the form, you must log in to your Netlify account. In the app's general data, under the app name, you'll find the `Build Instance URL`.
+
+<img src=".docs/images/app_url.png" alt="instance-url" width="700"/>
+
+To find `Build Webhook URL` go to `Site Configuration` -> `Build & deploy` -> `Build hooks`. You need to add a build hook and copy the provided URL.
+
+<img src=".docs/images/hook_url.png" alt="hook-url" width="1000"/>
+
+Other fields:
+
+* `Display name` - Any name that will be displayed on the build button.
+* `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/hook_url.png

@@ -1,8 +1,8 @@
 {
   "id": "flotiq.deploy-netlify",
   "name": "Deploy Netlify",
-  "description": "Integration with Netlify",
-  "version": "1.1.0",
+  "description": "Integration with Netlify deploy. With this plugin, you can easily trigger Netlify builds within Content Object changes on form submission. You will also be able to quickly navigate to your Netlify pages from the Flotiq content editor.",
+  "version": "1.1.1",
   "repository": "https://github.com/flotiq/flotiq-ui-plugin-deploy-netlify",
   "url": "https://localhost:3053/index.js",
   "permissions": []