Merge pull request #12 from cosmicjs/tony/readme

Tony/readme
cosmicjs · Mar 27, 2023 · 0c8fd1f · 0c8fd1f
2 parents dfcd621 + 2aea85b
commit 0c8fd1f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 15 deletions.
diff --git a/.changeset/large-pans-pull.md b/.changeset/large-pans-pull.md
@@ -0,0 +1,5 @@
+---
+'@cosmicjs/sdk': patch
+---
+
+update readme to include concise format for updateOne and deleteOne
diff --git a/README.md b/README.md
@@ -105,29 +105,20 @@ await cosmic.objects.insertOne({
 Use the `objects.updateOne()` method to update an Object by specifying the Object `id` and include properties that you want to update using `$set`.
 
 ```jsx
-await cosmic.objects.updateOne(
-  {
-    id: '5ff75368c2dfa81a91695cec',
+await cosmic.objects.updateOne('5ff75368c2dfa81a91695cec', {
+  content: 'This is the updated blog post content... I got it now!',
+  metadata: {
+    featured_post: false,
   },
-  {
-    $set: {
-      content: 'This is the updated blog post content... I got it now!',
-      metadata: {
-        featured_post: false,
-      },
-    },
-  }
-);
+});
 ```
 
 ### Delete Object [[see docs](https://docs-v3.cosmicjs.com/docs/api/objects#delete-an-object)]
 
 Use the `objects.deleteOne()` method to delete an Object by specifying the Object `id`.
 
 ```jsx
-await cosmic.objects.deleteOne({
-  id: '5ff75368c2dfa81a91695cec',
-});
+await cosmic.objects.deleteOne('5ff75368c2dfa81a91695cec');
 ```
 
 ## Learn more