update readme

dominikjasek · Jun 18, 2023 · 495b85a · 495b85a
1 parent cba0548
commit 495b85a
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 15 deletions.
diff --git a/.changeset/wet-pants-thank.md b/.changeset/wet-pants-thank.md
@@ -0,0 +1,5 @@
+---
+"required-properties": patch
+---
+
+update readme
diff --git a/README.md b/README.md
@@ -45,6 +45,8 @@ npm i required-properties
 
 ### `assertRequiredProperties`
 
+First argument is object, second argument is an array of properties which can be `null` or `undefined`. If nested object, you can separate properties with dot `.`
+
 ```ts
 interface Person {
     firstName: string | null;

diff --git a/package.json b/package.json
@@ -9,6 +9,7 @@
     "lint": "tsc",
     "dev": "tsup src/index.ts --watch --format cjs,esm --dts",
     "build": "tsup src/index.ts --format cjs,esm --dts",
+    "generate-changelog": "changeset",
     "release": "pnpm run build && changeset publish",
     "test": "vitest",
     "typecheck": "vitest typecheck"

diff --git a/tsconfig.vitest-temp.json b/tsconfig.vitest-temp.json