From 3bdecfea07800dd3e9e3d91d45d0fb24e8e31d75 Mon Sep 17 00:00:00 2001
From: Chris Gunther <chris@room118solutions.com>
Date: Tue, 10 Aug 2021 20:44:38 -0400
Subject: [PATCH] Explain search only fields in Readme

Attempt to document #483.

I wasn't sure how best to convey this given it affects consuming the search results, not performing the search itself. It should also be unsurprising that you'd access these search-only fields the same way you'd access regular or read-only fields.

Had we buried these search-only fields in custom fields, like #426 first attempted, then I'd find that more surprising and warranting clearer documentation.
---
 README.md | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c43664ab..1eb2bd56 100644
--- a/README.md
+++ b/README.md
@@ -421,7 +421,10 @@ NetSuite::Records::SalesOrder.search({
     'tranSales:basic' => [
       'platformCommon:internalId/' => {},
       'platformCommon:email/' => {},
-      'platformCommon:tranDate/' => {}
+      'platformCommon:tranDate/' => {},
+      # If you include columns that are only part of the *SearchRowBasic (ie. TransactionSearchRowBasic), 
+      # they'll be readable on the resulting record just like regular fields (my_record.close_date).
+      'platformCommon:closeDate/' => {}
     ],
     'tranSales:accountJoin' => [
       'platformCommon:internalId/' => {}