update README

README.md

@@ -1,3 +1,51 @@
 # Omnivore API
 
 Omnivore API Client Library for Node.js
+
+![Build status](https://github.com/omnivore-app/omnivore-api/actions/workflows/ci.yml/badge.svg)
+
+## Installation
+
+```bash
+npm install @omnivore/api
+```
+
+## Usage
+
+Import the `Omnivore` class and create a new instance with your `authToken` and `baseUrl`. Then you can use the instance to make requests to the Omnivore API.
+
+```javascript
+import { Omnivore } from '@omnivore/api'
+
+const omnivore = new Omnivore({
+  authToken: 'your-auth-token',
+  baseUrl: 'https://api-prod.omnivore.app',
+})
+
+const items = await omnivore.search({
+  // ...
+})
+```
+
+## Error handling
+
+The library will throw an error if the request fails. You can catch the error and handle it as needed.
+
+```javascript
+try {
+  const items = await omnivore.search({
+    // ...
+  })
+} catch (error: unknown) {
+  if (isOmnivoreError(error)) {
+    switch (error.code) {
+      case OmnivoreErrorCode.GraphQLError:
+        // Handle GraphQL error
+      case OmnivoreErrorCode.NetworkError:
+        // Handle network error
+      default:
+        // Handle other errors
+    }
+  }
+}
+```

package.json

@@ -43,7 +43,8 @@
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.3",
     "prettier": "^3.2.5",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "react": "^17.0.2"
   },
   "volta": {
     "node": "18.16.1",

src/errors.ts

@@ -53,3 +53,11 @@ export const buildOmnivoreError = (
 
   return new GraphQLError(data.errorCodes)
 }
+
+export const isOmnivoreError = (error: any): error is OmnivoreError => {
+  return (
+    error instanceof GraphQLError ||
+    error instanceof NetworkError ||
+    error instanceof UnknownError
+  )
+}

src/index.ts

@@ -15,4 +15,4 @@ export {
   UpdatesSinceResponse,
 } from './client'
 
-export { OmnivoreError, OmnivoreErrorCode } from './errors'
+export { OmnivoreError, OmnivoreErrorCode, isOmnivoreError } from './errors'