docs: add basic usage documentation

.prettierrc

@@ -2,5 +2,14 @@
 	"useTabs": true,
 	"tabWidth": 4,
 	"singleQuote": true,
-	"trailingComma": "all"
+	"trailingComma": "all",
+	"overrides": [
+		{
+			"files": "*.md",
+			"options": {
+				"useTabs": false,
+				"tabWidth": 2
+			}
+		}
+	]
 }

README.md

@@ -1,3 +1,81 @@
 # Bodek
 
-A zod-like schema validator
+A zod-like schema validator, 100% type-safe.
+
+Made for fun and learning purposes.
+
+## Installation
+
+```bash
+npm i bodek
+```
+
+## Usage
+
+The API is basically the same as [Zod](https://zod.dev/)'s, but only with the core functionality (again, learning purposes...)
+
+### `parse`:
+
+```typescript
+import { b } from 'bodek';
+
+const schema = b.object({
+  name: b.string().min(3).max(10),
+  age: b.number().min(18),
+});
+
+// No errors
+schema.parse({
+  name: 'John',
+  age: 30,
+});
+
+// Throws an error
+schema.parse({
+  name: 'John',
+  age: 10,
+});
+```
+
+### `safeParse`:
+
+```typescript
+import { b } from 'bodek';
+
+const schema = b.object({
+  name: b.string().min(3).max(10),
+  age: b.number().min(18),
+});
+
+const { success, data, error } = schema.safeParse({
+  name: 'John',
+  age: 30,
+});
+
+if (success) {
+  console.log(data);
+} else {
+  console.error(error);
+}
+```
+
+### `refine`:
+
+```typescript
+import { b } from 'bodek';
+
+const schema = b.object({
+  name: b
+    .string()
+    .min(3)
+    .max(10)
+    .refine((name) => name.toLowerCase() !== 'john', 'Name cannot be John'),
+  age: b.number().min(18),
+});
+
+// Throws an error
+schema.parse({
+  name: 'John',
+  age: 30,
+});
+```

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "bodek",
-	"description": "A zod-like schema validator ",
+	"description": "A zod-like schema validator, 100% type-safe",
 	"version": "0.0.0",
 	"author": "StyleShit",
 	"license": "MIT",