Merge pull request #35 from justinphilpott/release

Release 0.2.1
justinphilpott · Nov 12, 2024 · fcbad92 · fcbad92
2 parents f9b3592 + 0fcf2cf
commit fcbad92
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @jphil/bookwhen-client
 
+## 0.2.1
+
+### Patch Changes
+
+- 87f40d1: Docs tweaks
+
 ## 0.2.0
 
 ### Minor Changes

diff --git a/README.md b/README.md
@@ -36,12 +36,12 @@ pnpm add @jphil/bookwhen-client
 
 ```typescript
 // import the client factory
-import { createBookwhenClient } from 'bookwhen-client';
+import { createBookwhenClient } from '@jphil/bookwhen-client';
 
-// create the client
-const client = createBookwhenClient(YOUR_API_KEY)
+// create the client (optional debug param to get requests logged to console)
+const client = createBookwhenClient({ apiKey: 'your-API-key'[, debug = true]});
 
-// get a single event, using method on events Service
+// use events Service method to get a single event
 const event = client.events.getById({eventId: 'some-id'});
 
 // get all events
@@ -53,7 +53,7 @@ const events_2025 = client.events.getMultiple({
     from: '20250101',
     to: '20251231'
   ]
-})
+});
 
 ```
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@jphil/bookwhen-client",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "",
   "private": false,
   "main": "dist/index.js",