Add missing files

[postgresql/pg_jsonb_opx] / README.md

diff --git a/README.md b/README.md
index 1073f68b6c8a69ae2a4a9113d573a24a8ab129d2..0575f0d4176d9701dcb55f25b4400802bc202c9a 100755 (executable)
--- a/README.md
+++ b/README.md
@@ -1,9 +1,25 @@
 jsonb_opx
 =========
 
-Test delete and concatenation operators for PostgreSQL 9.4
+Missing operators for jsonb in PostgreSQL 9.4, this may contain some errors and bad form as it's primarily just experimentation (i'm not a frequent C programmer; but everyone has to start somewhere right?).  Please test that it suits your requirements before using in any production scenario.
 
-This is purely experimentation and will contain many errors and bad form.
+Provides
+--------
 
-**DO NOT USE ON PRODUCTION SYSTEMS**
+The following behave like hstore 1.x operators, i.e. without nested jsonb traversal
 
+* deletion using **-** operator
+  * jsonb_delete(jsonb, text)
+  * jsonb_delete(jsonb, text[])
+  * jsonb_delete(jsonb, jsonb)
+* concatenation using **||** operator
+  * jsonb_concat(jsonb, jsonb)
+* replacement using **=#** operator
+  * jsonb_replace(jsonb, jsonb)
+
+The following are intended to eventually function like hstore 2.0 operators
+
+* deletion at chained path using **#-** operator
+    jsonb_delete_path(jsonb, text[])
+* replacement at chained path using function
+    jsonb_replace_path(jsonb, text[], jsonb)