Tidy-up.

Author: judgej

README.md

@@ -1,19 +1,23 @@
 # wc-api-custom-meta
 WordPress/WooCommerce plugin to support custom meta fields through the product API
 
-A very simple plugin that allows you to create, update or remove custom meta fields when
-managing prducts through the WooCommerce API.
+A very simple plugin that allows you to view, create, update or remove custom meta fields when
+managing products through the WooCommerce API v2.
 
 It is necessary to install this plugin on the WC site providing the API.
+
 I have raised a ticket asking whether this can ever be a core feature of WooCommerce,
 but the ticket has been rejected:
 
 https://github.com/woothemes/woocommerce/issues/7593
 
 It may come back, but this plugin fills a gap in the meantime.
 
-To use it, add elements to the product array passed to the `products` entrypoint. Each element is
-an array, with examples that follow:
+## Modifying Product Meta
+
+To use it, add elements to the product array passed to the `products` POST entrypoint.
+Each element is an array, with examples below. Both `custom_meta` and `remove_custom_meta`
+elements are optional.
 
 ~~~php
 $product = [
@@ -22,6 +26,7 @@ $product = [
         ...
         'custom_meta' => [
             'my_custom_field_name' => 'my custom value',
+            'my_other_custom_field_name' => 'my other custom value',
         ],
         'remove_custom_meta' => [
             'remove_all_instances_of_this_field_name',
@@ -32,9 +37,9 @@ $product = [
 ~~~
 
 That's it. Make sure those elements are in your REST API request, and this plugin is installed at the other end,
-and you can set any meta fields you like.
+and you can set any meta fields you like, except for the protected fields (see below).
 
-I have not tested this with anything other than strings, so be wary that the behaviour storing other data structures
+I have not tested this with anything other than strings, so be aware that the behaviour storing other data structures
 in metafields are *undefined* at present.
 
 ## Returning Product Meta
@@ -43,17 +48,17 @@ When retrieving a product, the custom product meta fields will be put into the "
 retrieving a product through the API. This only works for capability 'manage_woocommerce' to help prevent
 leakage of secure data.
 
-The field will look something like this:
-
-    "meta": [
+The returned `meta` field will look something like this in structure:
 
-        {
-            "test custom field": "Hi There!",
-            "pv_commission_rate": "",
-            "ISBN": "1234567890-1"
-        }
-    ]
+~~~json
+"meta":
+{
+    "test custom field": "Hi There!",
+    "pv_commission_rate": "20%",
+    "ISBN": "978-1910223260"
+}
+~~~
 
-Both visibla and hidden ("_" prefixed) fields will be included in the list. All raw WooCommerce fields that 
+Both visible and hidden (with "_" prefixes) fields will be included in the list. All raw WooCommerce fields that 
 are already present in some form in the product data will be filtered out, leaving only fields added by
 third-party plugins or manually by the shop manager.

wc-api-custom-meta.php

@@ -106,7 +106,7 @@ public static function fetchCustomMeta($product_data, $product, $fields, $server
             }
             unset($value);
 
-            $meta = array($all_meta);
+            $meta = $all_meta;
 
             $product_data['meta'] = $meta;
         }