From 2e427158d9b735d58614b6cdc2029643257d68aa Mon Sep 17 00:00:00 2001
From: James Crosby <james@coggle.it>
Date: Mon, 29 Jan 2024 13:52:10 +0000
Subject: [PATCH] Fix syntax and consistently use mjs import in readme example.

---
 readme.md | 31 ++++++++++++++++++-------------
 1 file changed, 18 insertions(+), 13 deletions(-)

diff --git a/readme.md b/readme.md
index 162db3e..6c6dd04 100644
--- a/readme.md
+++ b/readme.md
@@ -6,39 +6,44 @@
 
 ## Quickstart:
 ```js
-const DynamoDM =  require('dynamodm')();
+import DynamoDM from 'dynamodm';
 
-const table = DynamoDM.Table('my-dynamodb-table');
+// get an instance of the API (options can be passed here)
+const ddm = DynamoDM();
+
+// get a reference to a DynamoDM table:
+const table = ddm.Table({name: 'my-dynamodb-table'});
 
 // Create a User model with a JSON schema:
-const UserModel = table.model(DynamoDM.Schema('user', {
+const UserModel = table.model(ddm.Schema('user', {
     properties: {
         // Identify the id field using the built-in schema. Every model in the same table must share the same id field name:
-        id: DynamoDM.DocIdField,
+        id: ddm.DocIdField,
         emailAddress: {type: 'string'},
         marketingComms: {type: 'boolean', default: false}
     },
 }));
 // and a Comment model:
-const CommentModel = table.model(DynamoDM.Schema('c', {
+const CommentModel = table.model(ddm.Schema('c', {
     properties: {
-        id: DynamoDM.DocIdField,
-        createdAt: DynamoDM.CreatedAtField,
+        id: ddm.DocIdField,
+        createdAt: ddm.CreatedAtField,
         text: {type: 'string' },
-        user: DynamoDM.DocId
+        user: ddm.DocId
     },
     additionalProperties: true
-}, index: {
-    findByUser: {
-        hashKey: 'user',
-        sortKey: 'createdAt'
+}, {
+    index: {
+        findByUser: {
+            hashKey: 'user',
+            sortKey: 'createdAt'
+        }
     }
 }));
 
 // wait for the table to be ready (created if necessary, creation of index):
 await table.ready();
 
-
 // create some documents (instances of models):
 const aUser = new UserModel({emailAddress:"friend@example.com"});
 await aUser.save();