Update readme and add screenshots

Author: vishalkakadiya

README.md

@@ -1,6 +1,37 @@
-# WP Comment Preview - (In Progress)
-Plugin for WordPress Comment Preview
+# WP Comment Preview
 
 [![Build Status](https://app.travis-ci.com/vishalkakadiya/comment-preview.svg?branch=main)](https://app.travis-ci.com/vishalkakadiya/comment-preview)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/vishalkakadiya/comment-preview/badges/quality-score.png?b=main)](https://scrutinizer-ci.com/g/vishalkakadiya/comment-preview/?branch=main)
 [![Code Coverage](https://scrutinizer-ci.com/g/vishalkakadiya/comment-preview/badges/coverage.png?b=main)](https://scrutinizer-ci.com/g/vishalkakadiya/comment-preview/?branch=main)
+
+This plugin will show real comment preview to the users, it's also supporting jetpack's markdown.
+
+#### Steps to configure this plugin in your site:
+
+- Activate jetpack's markdown module.
+- ![Activate Jetpack's markdown module](https://github.com/vishalkakadiya/comment-preview/tree/main/screenshots/enable-jetpack-markdown.png)
+
+- Activate jetpack markdown for comments settings.
+- ![Activate jetpack markdown for comments settings](https://github.com/vishalkakadiya/comment-preview/tree/main/screenshots/enable-markdown-for-comments.png)
+
+- Activate comment preview plugin now.
+- ![Activate comment preview plugin](https://github.com/vishalkakadiya/comment-preview/tree/main/screenshots/enable-comment-preview-plugin.png)
+
+- Comment's form and preview of comment.
+- ![Comment's form and preview of comment](https://github.com/vishalkakadiya/comment-preview/tree/main/screenshots/working-comment-preview.png)
+
+#### Support for Custom Post Type?
+
+Yes, this plugin is giving support for custom post types, for that you can use below filter.
+- `wp_comment_preview_allowed_post_types`: Returning array of post types will support those post types.
+
+**NOTE:** This plugin works with WordPress's default comment form only.
+
+#### Available Endpoint
+
+**Get single post ( POST request )**
+- http://example.com/wp-json/wp_comment_preview/v1/preview
+  - Params:
+    - `comment` - Comment text.
+    - `format` - Whether to preview markdown or plain text - Two values it will take `plain` OR `markdown`.
+    - `author` - For non-logged in user you can send author's name here, logged-in users will automatically get their name in that comment. 

clover.xml

@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<coverage generated="1632933931">
-  <project timestamp="1632933931">
+<coverage generated="1632940952">
+  <project timestamp="1632940952">
     <package name="CommentPreview\Inc">
       <file name="/var/www/app/inc/classes/class-comment-preview.php">
         <class name="CommentPreview\Inc\Comment_Preview" namespace="CommentPreview\Inc" fullPackage="CommentPreview" package="CommentPreview">
-          <metrics complexity="17" methods="8" coveredmethods="8" conditionals="0" coveredconditionals="0" statements="58" coveredstatements="58" elements="66" coveredelements="66"/>
+          <metrics complexity="18" methods="8" coveredmethods="8" conditionals="0" coveredconditionals="0" statements="58" coveredstatements="58" elements="66" coveredelements="66"/>
         </class>
         <line num="20" type="method" name="__construct" visibility="public" complexity="1" crap="1" count="10"/>
         <line num="22" type="stmt" count="10"/>
@@ -54,7 +54,7 @@
         <line num="150" type="stmt" count="10"/>
         <line num="151" type="stmt" count="10"/>
         <line num="152" type="stmt" count="10"/>
-        <line num="164" type="method" name="generate_preview" visibility="public" complexity="8" crap="8" count="2"/>
+        <line num="164" type="method" name="generate_preview" visibility="public" complexity="9" crap="9" count="2"/>
         <line num="166" type="stmt" count="2"/>
         <line num="168" type="stmt" count="2"/>
         <line num="169" type="stmt" count="2"/>

inc/classes/class-comment-preview.php

@@ -171,7 +171,7 @@ public function generate_preview( $request ) {
 
 		$user_id = ( ( is_user_logged_in() ) ? get_current_user_id() : 0 );
 
-		if ( ! empty( $user_id ) ) {
+		if ( ! empty( $user_id ) && empty( $response['author'] ) ) {
 
 			$user = get_userdata( $user_id );