better readme

botpress · Feb 7, 2024 · 40dce59 · 40dce59
1 parent bd99dfe
commit 40dce59
Showing 1 changed file with 41 additions and 0 deletions.
diff --git a/jex/readme.md b/jex/readme.md
@@ -1,3 +1,44 @@
 # Jex
 
 JSON-Extends; JSON Schema type checking library
+
+## Usage
+
+```typescript
+import * as jex from '.'
+
+const res1 = jex.jsonSchemaExtends(
+  {
+    type: 'object',
+    properties: {
+      name: { type: 'string' },
+      age: { type: 'number' }
+    }
+  },
+  {
+    type: 'object',
+    properties: {
+      name: { type: 'string' }
+    }
+  }
+)
+console.log(res1) // true
+
+const res2 = jex.jsonSchemaExtends(
+  {
+    type: 'object',
+    properties: {
+      name: { type: 'string' },
+      age: { type: 'number' }
+    }
+  },
+  {
+    type: 'object',
+    properties: {
+      name: { type: 'string' }
+    },
+    required: ['name']
+  }
+)
+console.log(res2) // false
+```