Skip to content

Commit 2b6bd44

Browse files
committed
docs(readme): tighten copy and remove doc outline 🙉
- Change Documentation label to Full documentation and remove section bullet list - Shorten Benchmark description and remove semicolon - Shorten Features descriptions and remove code references and semicolons - Simplify Contributing Code & docs line
1 parent 6cc83c2 commit 2b6bd44

File tree

1 file changed

+11
-18
lines changed

1 file changed

+11
-18
lines changed

README.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ Build HTTP server effortlessly with zero configuration for productivity.
1010

1111
## Features
1212

13-
- **Zero Config** — No build step for the server. Point to a routes directory and serve.
14-
- **File-Based Routing**Drop files in `routes/`; export `GET`, `POST`, etc. File structure is your API.
15-
- **Context**Request wrapper: body (JSON/form/text), query, params, cookies, headers, `ctx.send`.
16-
- **Middleware** — Global, path-specific. CORS, SecHeaders, Body Limit, Basic Auth, Session, WebSocket.
17-
- **Static Files**`router.static(urlPath, options)` with optional etag and cache-control.
18-
- **Error Handling**Pluggable error response builder and error middleware; default HTML/JSON by `Accept`.
19-
- **Worker Pool**Optional worker pool for CPU-bound work; enable via `worker: { scriptURL, poolSize }`.
20-
- **Frontend Optional** — Use any stack (Vite, React, etc.); Deserve stays the server.
13+
- **Zero Config** — No build step. Point to routes and serve.
14+
- **File-Based Routing**Put route files in a folder, URL follows that structure.
15+
- **Context**Body, query, params, cookies, headers, plus helpers to respond.
16+
- **Middleware** — Global or per path. CORS, auth, session, WebSocket.
17+
- **Static Files**Serve directories with optional cache and etag.
18+
- **Error Handling**Custom or default HTML/JSON error responses.
19+
- **Worker Pool**Offload heavy work to a pool so the server stays responsive.
20+
- **Frontend Optional** — Use any frontend. Deserve stays the server.
2121

2222
## Installation
2323

@@ -84,23 +84,16 @@ deno task check
8484
deno task test
8585
```
8686

87-
**Benchmark**performance runs with autocannon; see [benchmark/README.md](benchmark/README.md) for how to run and interpret results.
87+
**Benchmark**autocannon runs. [benchmark/README.md](benchmark/README.md) for details.
8888

8989
## Documentation
9090

91-
Full docs (EN / ID): **[docs-deserve.neabyte.com](https://docs-deserve.neabyte.com)**
92-
93-
- **Getting Started** — Installation, Quick Start, Server & Routes configuration
94-
- **Core Concepts** — Philosophy, file-based routing, route patterns, Context, request handling
95-
- **Middleware** — Global, route-specific, Basic Auth, Body Limit, CORS, Security Headers, WebSocket
96-
- **Response** — JSON, text, HTML, file/data download, redirect, custom
97-
- **Static Files** — Basic and multiple directories
98-
- **Error Handling** — Default behavior, error object details
91+
Full documentation (EN / ID): **[docs-deserve.neabyte.com](https://docs-deserve.neabyte.com)**
9992

10093
## Contributing
10194

10295
- **Bugs & ideas**[GitHub Issues](https://github.com/NeaByteLab/Deserve/issues)
103-
- **Code & docs**[Pull Requests](https://github.com/NeaByteLab/Deserve/pulls) welcome; docs support English and Indonesian.
96+
- **Code & docs**[Pull Requests](https://github.com/NeaByteLab/Deserve/pulls) welcome.
10497
- **Use it** — Try Deserve in your projects and share feedback.
10598

10699
## License

0 commit comments

Comments
 (0)