Update README.md

Author: niki-cy

README.md

@@ -1 +1,51 @@
-# SAMPLE-Profile-tooltip-Plug-in
+# [Sample plug-in: Profile Tooltip Plug-in]
+## Purpose of the Sample Plug-in
+This sample plug-in is available for educational purposes.  
+Use this plug-in to understand how Kintone plug-ins work, and how they are structured.
+
+## What the plug-in does
+This plug-in displays tooltips next to users listed in the User Selection field when they are hovered over with a mouse.
+
+## Plug-in directory structure
+This sample plug-in is created with the following directory structure.
+
+src/  
+├── html/  
+│        └──── config.html  
+├── css/  
+│        ├──── 51-modern-default.css  
+│        ├──── config.css  
+│        └──── desktop.css  
+├── js/  
+│        ├──── config.js  
+│        └──── desktop.js  
+├── image/  
+│        └──── comment.png  
+└── manifest.json  
+
+## How to use
+To simply test out the plug-in on your Kintone domain, follow these steps:
+
+1. Download the plug-in zip file  
+Reference: https://github.com/kintone/SAMPLE-Date-input-button-Plug-in/releases
+2. Install the plug-in into your domain  
+Reference: https://get.kintone.help/hc/en-us/articles/115001519707-Installing-Viewing-Plug-ins
+3. Add the plug-in to a specific Kintone App  
+Reference: https://get.kintone.help/hc/en-us/articles/115001511188-Adding-Plug-ins-to-an-App
+4. Make sure that a User Selection field is placed in the form of your Kintone App. Access the plug-in settings, and set up the neccessary settings. Save the settings, and update the App.
+5. Click the + button on the Record List page to start adding a new record. Add a user (or multiple users) to the User Selection field and save the record. Hover over a user in the User Selection field. A black tooltip with user information should appear to the right.
+
+## How to modify
+1. Fork to your repo
+2. Make changes to files under /src
+3. Repackage the plug-in by:  
+ i. Zipping the manifest.json file, css directory, html directory, image directory and js directory into one zip file.  
+ ii. Drag and dropping the file into the [kintone plug-in packer](https://kintone.github.io/plugin-packer/).
+
+## Pull Request Policy
+As this repo exists for educational purposes, we will most likely turn down pull requests that contain updates with new features.  
+Please feel free to host plug-ins with new features on your own repository.  
+Bug fixes are happily accepted.
+
+## More information
+This sample plug-in uses Tippy.js, found here: https://atomiks.github.io/tippyjs/