Merge pull request #3 from Groupguanfang/main

feat: add README for zod package, update package.json

Author: Groupguanfang

packages/schema/README.md

@@ -0,0 +1,23 @@
+# @usf-org/schema
+
+Zod schema for USF.
+
+## Usage
+
+```ts
+import { Schema } from '@usf-org/schema'
+
+const schema = Schema.safeParse({})
+```
+
+You also can use `toJsonSchema` to get the JSON Schema of the schema.
+
+```ts
+import { toJsonSchema } from '@usf-org/schema'
+
+const jsonSchema = toJsonSchema(Schema)
+```
+
+## License
+
+[MIT](../../LICENSE)

packages/schema/package.json

@@ -1,9 +1,20 @@
 {
   "name": "@usf-org/zod",
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Zod schema for USF.",
   "author": "Naily Zero <zero@naily.cc> (https://naily.cc)",
+  "license": "MIT",
+  "homepage": "https://github.com/USF-org/USF-TS",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/USF-org/USF-TS.git",
+    "directory": "packages/schema"
+  },
+  "bugs": {
+    "url": "https://github.com/USF-org/USF-TS/issues",
+    "email": "zero@naily.cc"
+  },
   "keywords": [
     "zod",
     "schema",
@@ -19,6 +30,12 @@
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">16"
+  },
   "scripts": {
     "build": "tsup",
     "watch": "tsup -w",