Add readme

Author: gianlucaparadise

Diff for: .editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{package.json,*.yml}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

Diff for: .eslintignore

@@ -0,0 +1,3 @@
+.cache
+build
+**/node_modules/**

Diff for: .eslintrc

@@ -0,0 +1,27 @@
+{
+  "parser": "babel-eslint",
+  "extends": "eslint:recommended",
+  "env": {
+    "commonjs": true,
+    "es6": true,
+    "node": true,
+    "browser": false
+  },
+  "parserOptions": {
+    "ecmaFeatures": {
+      "experimentalObjectRestSpread": true,
+      "jsx": false
+    },
+    "sourceType": "module"
+  },
+  "globals": {
+    "strapi": true
+  },
+  "rules": {
+    "indent": ["error", 2, { "SwitchCase": 1 }],
+    "linebreak-style": ["error", "unix"],
+    "no-console": 0,
+    "quotes": ["error", "single"],
+    "semi": ["error", "always"]
+  }
+}

Diff for: README.md

@@ -1,20 +1,85 @@
 # Vercel Deploy
 
-Strapi v4 plugin to trigger and monitor a deployment on Vercel
+Strapi v4 plugin to trigger and monitor a deployment on Vercel.
+
+![Vercel Deploy Logo](./assets/strapi-vercel-deploy-logo.png "Vercel Deploy Logo")
+
+## Plugin Preview
+
+Home Page:
+
+![Plugin Home Page](./assets/strapi-vercel-deploy-home.png "Plugin Home Page")
+
+Settings Page:
+
+![Plugin Settings Page](./assets/strapi-vercel-deploy-settings.png "Plugin Settings Page")
+
+## Installation
+
+### Install dependency
+
+Run the following command in your Strapi project to install vercel-deploy:
+
+```shell
+yarn add strapi-plugin-vercel-deploy
+# or
+npm i -S strapi-plugin-vercel-deploy
+```
+
+### Enable plugin configuration
+
+Open `config/plugins.js` file and add the vercel-deploy entry:
+
+```
+module.exports = ({ env }) => ({
+  "vercel-deploy": {
+    enabled: true,
+  },
+});
+
+```
+
+### Run
+
+You can now run Strapi:
+
+```
+yarn develop
+```
+
+You should see the **Vercel Deploy** menu in the left panel.
+
+**N.B.** You _may_ need to run `yarn build` in order to see the new menu entries.
+
+Then you can proceed with the environment config
 
 ## Environment Conifg
 
-In order to use the plugin, you need to set the following environment variables:
+### Config properties
+
+The plugin is reading the following environment variable to work:
 
 - `VERCEL_DEPLOY_PLUGIN_HOOK`: Url of the git deploy hook exposed in Vercel.
+
   - You can follow [this](https://vercel.com/docs/git/deploy-hooks) guide to create a deploy hook on Vercel
-  - Then you can save the hook url as process env variable (e.g. [this](https://devcenter.heroku.com/articles/config-vars) guide is for Heroku)
 
-- `VERCEL_DEPLOY_PLUGIN_API_TOKEN`: API token of your Vercel account used to fetch the list of deployments 
+- `VERCEL_DEPLOY_PLUGIN_API_TOKEN`: API token of your Vercel account used to fetch the list of deployments
+
   - Access tokens can be created and managed inside your [account settings](https://vercel.com/account/tokens)
-  - Then you can save the hook url as process env variable (e.g. [this](https://devcenter.heroku.com/articles/config-vars) guide is for Heroku)
 
 - `VERCEL_DEPLOY_PLUGIN_APP_FILTER`: Name of your Vercel App used to filter the list of deployments
   - Set the name of your [Vercel App](https://vercel.com/dashboard) to see only the deployments you need
-  - Then you can save the hook url as process env variable (e.g. [this](https://devcenter.heroku.com/articles/config-vars) guide is for Heroku)
 
+### Local development
+
+For local development, you can add the config properties in your `.env` file:
+
+```
+VERCEL_DEPLOY_PLUGIN_HOOK="https://api.vercel.com/v1/integrations/deploy/prj_<deploy-hook>"
+VERCEL_DEPLOY_PLUGIN_API_TOKEN="<vercel-api-token>"
+VERCEL_DEPLOY_PLUGIN_APP_FILTER="your-app-name-on-vercel"
+```
+
+### Server
+
+You can save these values as process env variable on your server (e.g. [this](https://devcenter.heroku.com/articles/config-vars) guide is for Heroku).