docs: add getting-started guide in readme

Author: do4ng

README.md

@@ -6,7 +6,7 @@ Fast Backend Framework
 
 - **🔥 Fully TypeScript support**
 - **🚀 Automatic server reload**
-- **🎯 File based routing**
+- **🎯 File-based routing**
 
 ## Getting Started
 
@@ -21,6 +21,50 @@ Available templates:
 - TypeScript _(recommended)_
 - JavaScript
 
+## Routes
+
+Dobs uses a simple and intuitive file-based routing system.
+All route files must be placed inside the `/app/` directory.
+Each file automatically becomes a route based on its path.
+
+For example:
+
+```
+project/
+ └─ app/
+     ├─ index.ts       →  /
+     ├─ user.ts        →  /user
+     └─ post/
+         └─ [id].ts    →  /post/:id
+```
+
+### Example
+
+```ts
+import { defineRoutes } from 'dobs';
+
+export default defineRoutes((req, res) => {
+  res.send('Hello from Dobs!');
+});
+```
+
+This route responds with `"Hello from Dobs!"` for all HTTP methods.
+
+If you want to handle methods separately:
+
+```ts
+import { defineRoutes } from 'dobs';
+
+export default defineRoutes({
+  GET(req, res) {
+    res.send({ message: 'This is GET' });
+  },
+  POST(req, res) {
+    res.send({ message: 'This is POST' });
+  },
+});
+```
+
 ## LICENSE
 
 MIT

package.json

@@ -38,7 +38,8 @@
     "lint-fix": "eslint --fix --ext .js,.ts .",
     "test": "vitest run",
     "build": "tsdown",
-    "run-script": "node -r @swc-node/register"
+    "run-script": "node -r @swc-node/register",
+    "publish": "lerna version && yarn build && lerna publish from-package"
   },
   "version": "0.0.0",
   "packageManager": "yarn@4.10.3"

packages/dobs/README.md

@@ -1,6 +1,12 @@
 # dobs
 
-Lightweight backend framework
+Fast Backend Framework
+
+## Features
+
+- **🔥 Fully TypeScript support**
+- **🚀 Automatic server reload**
+- **🎯 File-based routing**
 
 ## Getting Started
 
@@ -15,6 +21,50 @@ Available templates:
 - TypeScript _(recommended)_
 - JavaScript
 
+## Routes
+
+Dobs uses a simple and intuitive file-based routing system.
+All route files must be placed inside the `/app/` directory.
+Each file automatically becomes a route based on its path.
+
+For example:
+
+```
+project/
+ └─ app/
+     ├─ index.ts       →  /
+     ├─ user.ts        →  /user
+     └─ post/
+         └─ [id].ts    →  /post/:id
+```
+
+### Example
+
+```ts
+import { defineRoutes } from 'dobs';
+
+export default defineRoutes((req, res) => {
+  res.send('Hello from Dobs!');
+});
+```
+
+This route responds with `"Hello from Dobs!"` for all HTTP methods.
+
+If you want to handle methods separately:
+
+```ts
+import { defineRoutes } from 'dobs';
+
+export default defineRoutes({
+  GET(req, res) {
+    res.send({ message: 'This is GET' });
+  },
+  POST(req, res) {
+    res.send({ message: 'This is POST' });
+  },
+});
+```
+
 ## LICENSE
 
 MIT