Merge pull request #29 from julbrs/edit-readme

Add a section in README to explain CommonJS/ESM status

README.md

@@ -10,6 +10,10 @@ Make requests to SuiteTalk REST Web Services
 
     npm i netsuite-rest
 
+### ESM or CommonJS?
+
+This package is still compatible with CommonJS. But some dependencies, like [`got`](https://www.npmjs.com/package/got) are now available only in [ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules). This package [will not be](https://github.com/ehmad11/netsuite-rest/issues/27) modified to support latest `got` versions to stay compatible with CommonJS. Instead you can use the native ESM module [netsuite-api-client](https://www.npmjs.com/package/netsuite-api-client), which is a fork of the current package.
+
 ## Quick Start
 
 To set up TBA in Netsuite, see the help topic [Getting Started with Token-based Authentication](https://system.netsuite.com/app/help/helpcenter.nl?fid=section_4247337262.html).
@@ -89,4 +93,4 @@ You can navigate to the referenced resources without deeper knowledge of the sys
 
 ### Netsuite Rest API Browser
 
-[REST API Browser](https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2021.2/index.html) provides a visual overview of the structure and capabilities of the REST web services Record API. The data presented in the REST API Browser is based on OpenAPI 3.0 metadata.
+[REST API Browser](https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2021.2/index.html) provides a visual overview of the structure and capabilities of the REST web services Record API. The data presented in the REST API Browser is based on OpenAPI 3.0 metadata.