Create readme.md

Author: orthagonal

readme.md

@@ -0,0 +1,67 @@
+<h1 align="center">unique-wp-query</h1>
+
+<p align="center">
+  <a href="https://github.com/firstandthird/unique-wp-query/actions">
+    <img src="https://img.shields.io/github/workflow/status/firstandthird/unique-wp-query/Test/main?label=Tests&style=for-the-badge" alt="Test Status"/>
+  </a>
+  <a href="https://github.com/firstandthird/unique-wp-query/actions">
+    <img src="https://img.shields.io/github/workflow/status/firstandthird/unique-wp-query/Lint/main?label=Lint&style=for-the-badge" alt="Lint Status"/>
+  </a>
+  <img src="https://img.shields.io/npm/v/unique-wp-query.svg?label=npm&style=for-the-badge" alt="NPM" />
+</p>
+
+unique-wp-query is a Wordpress plugin that can be used to ensure no post is 
+loaded more than once per screen
+
+## Features
+
+* ensures only one of each post is loaded
+
+## Installation
+
+just put the root folder in your __wp-content/plugins__ directory and Activate 
+from the plugins console 
+
+## Usage:
+
+From the demo:
+
+```php
+$latest_posts1 = new Unique_WP_Query([
+  'post_type' => 'post',
+  'posts_per_page' => 3,
+  'post_status' => 'publish',
+  'post__not_in' => array(18)
+]);
+$latest_posts2 = new Unique_WP_Query([
+  'post_type' => 'post',
+  'posts_per_page' => 3,
+  'post_status' => 'publish',
+]);
+while ($latest_posts1->have_posts()) {
+  $latest_posts1->the_post();
+  echo get_the_title(), '<br>';
+}
+echo "<br><br>---------------------------------------------------------------------<br><br>";
+while ($latest_posts2->have_posts()) {
+  $latest_posts2->the_post();
+  echo get_the_title(), '<br>';
+}
+```
+
+The second list will not include any posts that were in the first
+
+
+## Demo:
+
+```
+This repo includes a docker-compose with a dummy theme that demonstrates the plugin, to use it:
+    - __docker-compose up__
+    - Open a browser and log in to the Wordpress server 
+    - Add some dummy posts and then load the main page
+```
+
+
+<a href="https://firstandthird.com"><img src="https://firstandthird.com/_static/ui/images/safari-pinned-tab-62813db097.svg" height="32" width="32" align="right"></a>
+
+_A [First + Third](https://firstandthird.com) Project_