From f703f2342f46474e1add2beb136bd14e9f752cb7 Mon Sep 17 00:00:00 2001
From: Josh Pollock <josh@calderawp.com>
Date: Thu, 5 Apr 2018 21:55:26 -0400
Subject: [PATCH] improve readme
---
README.md | 13 +++++++++++++
caldera-forms-query.php | 21 ---------------------
2 files changed, 13 insertions(+), 21 deletions(-)
delete mode 100644 caldera-forms-query.php
diff --git a/README.md b/README.md
index 1a8c818..5757c2f 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,18 @@
[](https://travis-ci.org/calderawp/caldera-forms-query)
+This library provides for developer-friendly ways to query for or delete Caldera Forms entry data.
+
+## Why?
+* [To provide the types of queries we need for reporting and deleting data in order to add GDPR compliance to Caldera Forms]https://github.com/CalderaWP/Caldera-Forms/issues/2108
+* To provide the types of queries we need for improving Caldera Forms features such as entry viewer, entry export, entry editing and Connected Forms.
+
+## Install
+`composer require calderawp/caldera-forms-query`
+
+## Status
+* Works
+* Does not yet select/delete by date range
+* **Prepared SQL needs to be sanitized better.**
## Usage
```php
diff --git a/caldera-forms-query.php b/caldera-forms-query.php
deleted file mode 100644
index 9efda7e..0000000
--- a/caldera-forms-query.php
+++ /dev/null
@@ -1,21 +0,0 @@
-<?php
-/**
- * Plugin Name: Caldera Query
- * Plugin URI: PLUGIN SITE HERE
- * Description: PLUGIN DESCRIPTION HERE
- * Author: YOUR NAME HERE
- * Author URI: YOUR SITE HERE
- * Text Domain: caldera-forms-query
- * Domain Path: /languages
- * Version: 0.1.0
- *
- */
-
-include_once __DIR__ .'/vendor/autoload.php';
-
-if( function_exists( 'add_action' ) ){
- add_action( 'caldera_forms_includes_complete', function(){
-
- });
-}
-
--
GitLab