docs: rewrite

Author: rayriffy

README.md

@@ -1,22 +1,24 @@
-# Elysia remote DTS
+# Elysia Remote DTS
 
-A plugin that provide `.d.ts` types remotely for Eden Treaty to consume.
+A plugin that provides remote `.d.ts` types for Eden Treaty to consume.
 
 [![NPM Version](https://img.shields.io/npm/v/elysia-remote-dts)](https://www.npmjs.com/package/elysia-remote-dts)
 [![NPM Downloads](https://img.shields.io/npm/dw/elysia-remote-dts)](https://www.npmjs.com/package/elysia-remote-dts)
 [![NPM License](https://img.shields.io/npm/l/elysia-remote-dts)](https://www.npmjs.com/package/elysia-remote-dts)
 
-Imagine in this scenario, you deploy an Elysia server remotely somewhere. And you also want to provide the benefit of end-to-end type safety by using [Eden Treaty](https://elysiajs.com/eden/overview#eden-treaty-recommended). But external developer may not have a direct access to source code to pull `typeof app` types out from your server maybe because.
+## Problem
 
-- Your server is closed-source.
-- Frontend locate somewhere else that make types inaccessible.
+Imagine this scenario: You've deployed an Elysia server remotely and want to provide end-to-end type safety using [Eden Treaty](https://elysiajs.com/eden/overview#eden-treaty-recommended). However, external developers don't have direct access to your server's source code to extract the `typeof app` types because:
 
-This plugin will attempt to expose types remotely, and provide remote type to Eden Treaty to consume somehow.
+- Your server is closed-source
+- The frontend is located elsewhere, making types inaccessible
+
+This plugin solves this problem by exposing types remotely and providing them to Eden Treaty for consumption.
 
 > [!NOTE]  
-> Part of the code that responsible for runtime type-generation is copied from project [rolldown-plugin-dts](https://github.com/sxzz/rolldown-plugin-dts), what difference is this `generateDts` utility is completely dependent, and decoupled from rolldown lifecycle. Full credit should go to them, I just port some functionality that hoped to be cool stuff on Elysia ecosystem.
+> The code responsible for runtime type-generation is adapted from [rolldown-plugin-dts](https://github.com/sxzz/rolldown-plugin-dts). The difference is that our `generateDts` utility is completely independent and decoupled from the rolldown lifecycle. Full credit goes to the original developers - we've simply ported some functionality to enhance the Elysia ecosystem.
 
-## Install
+## Installation
 
 ```
 bun add elysia-remote-dts
@@ -30,23 +32,25 @@ import { dts } from 'elysia-remote-dts'
 
 const app = new Elysia().use(dts('./src/index.ts')).listen(3000)
 
-// Be sure to export type for plugin to consume as well.
+// Be sure to export the type for the plugin to consume
 export type App = typeof app;
 ```
 
-Then types should be available at `/server.d.ts`.
+Types will then be available at `/server.d.ts`.
 
-Due to limitations with [Triple-Slash Directives](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html), types cannot be directly consumed from a remote URL ([tracking issue](https://github.com/microsoft/TypeScript/issues/28985)). For frontend projects, you'll need to first download the type declaration file from this path before using it with Eden.
+Due to limitations with [Triple-Slash Directives](https://www.typescriptlang.org/docs/handbook/triple-slash-directives.html), types cannot be directly consumed from a remote URL ([tracking issue](https://github.com/microsoft/TypeScript/issues/28985)). For frontend projects, you'll need to first download the type declaration file before using it with Eden:
 
 ```
 curl -o server.ts https://<remote-url>/server.d.ts
 ```
 
+Then use it in your frontend code:
+
 ```ts
 import { treaty } from '@elysiajs/eden'
 import type { App } from './server'
 
-// frontend project should already have both elysia, and @elysiajs/eden installed
+// Your frontend project should already have both elysia and @elysiajs/eden installed
 export const app = treaty<App>('https://<remote-url>')
 ```
 
@@ -61,7 +65,7 @@ dts(entryPoint, options)
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
 | `cwd` | `string` | Current directory | The directory where the plugin will look for the `tsconfig.json` file. |
-| `dtsInput` | `boolean` | `false` | When entries are `.d.ts` files (instead of `.ts` files), this option should be set to `true`. If enabled, the plugin will skip generating a `.d.ts` file for the entry point. |
+| `dtsInput` | `boolean` | `false` | Set to `true` when entries are `.d.ts` files (instead of `.ts` files). When enabled, the plugin will skip generating a `.d.ts` file for the entry point. |
 | `tsconfig` | `string \| boolean` | `"tsconfig.json"` | The path to the `tsconfig.json` file. When set to `false`, any `tsconfig.json` file will be ignored. |
 | `compilerOptions` | `object` | `{}` | The `compilerOptions` for the TypeScript compiler. See [TypeScript compiler options](https://www.typescriptlang.org/docs/handbook/compiler-options.html). |
 | `resolve` | `boolean \| (string \| RegExp)[]` | `false` | Resolve external types used in `.d.ts` files from `node_modules`. Can be a boolean or an array of strings/RegExp patterns. |
@@ -87,6 +91,8 @@ export type App = typeof app;
 
 ## Known Limitations
 
-1. Sometimes emitting types can be `null`, this happens only in some runtime environment (So far, Distroless). I would recommended `oven/bun`, or `oven/bun:alpine` as base image.
-2. Be sure that `typescript` package is available when running. It's no longer `devDependencies`.
-3. For all elysia instances, and chaining controller. It's recomended to chain your routes instead of calling `controller.<METHOD>` after each new line since it's will not considered into type compliation by typescript. ([example](https://github.com/rayriffy/dts-chaining-repro/commit/fb4702ddc11a3973bf51eac753c18c1d606eae4b))
+1. Type emission may occasionally return `null` in certain runtime environments (particularly in Distroless). We recommend using `oven/bun` or `oven/bun:alpine` as your base image.
+
+2. The `typescript` package must be available at runtime, not just as a development dependency.
+
+3. For all Elysia instances and controller chaining, it's recommended to chain your routes rather than calling `controller.<METHOD>` on separate lines, as the latter approach won't be properly included in type compilation by TypeScript. ([example](https://github.com/rayriffy/dts-chaining-repro/commit/fb4702ddc11a3973bf51eac753c18c1d606eae4b))