doc: 📚 add the project status and roadmap into README.md

Author: CoderSerio

PR_TEMPLATE.md

@@ -0,0 +1,24 @@
+## Description
+
+This PR optimizes/implements....
+
+## Changes
+
+- **Feature 1**:
+  - Desc1...
+  - Desc2...
+
+- **Feature 2**:
+  - Desc1...
+  - Desc2...
+
+## Benchmarks
+
+_(Benchmarks show that...)_
+
+## Checklist
+
+- [ ] Code compiles and passes linter (`cargo check`, `npm run lint`)
+- [ ] Added/Updated tests in `__test__/xxx.spec.ts`
+- [ ] Verified performance improvements with `benchmark/xxx.ts`
+- [ ] Updated type definitions

README.md

@@ -1,83 +1,158 @@
 # Hyper-FS
 
-# Development
+<p align="center">
+  <img src="https://img.shields.io/badge/Written%20in-Rust-orange?style=flat-square" alt="Written in Rust">
+  <img src="https://img.shields.io/npm/v/hyper-fs?style=flat-square" alt="NPM Version">
+  <img src="https://img.shields.io/npm/l/hyper-fs?style=flat-square" alt="License">
+</p>
 
-1. Run `pnpm install` to install dependencies.
-2. Edit files in `/src`
-3. Run `pnpm build` to build the lib could be invoked by Node.js
-4. Run `pnpm test` to check if everything is ok
+<p align="center">
+  A high-performance, drop-in replacement for Node.js <code>fs</code> module, powered by Rust.
+</p>
 
-## Install this test package
+## Installation (⚠️ Not Ready Yet)
 
 ```bash
-yarn add @napi-rs/package-template
+npm install hyper-fs
+# or
+pnpm add hyper-fs
 ```
 
-## Ability
+## Status & Roadmap
 
-### Build
+We are rewriting `fs` APIs one by one.
 
-After `yarn build/npm run build` command, you can see `package-template.[darwin|win32|linux].node` file in project root. This is the native addon built from [lib.rs](./src/lib.rs).
+> **Legend**
+>
+> - ✅: Fully Supported
+> - 🚧: Partially Supported / WIP
+> - ✨：New feature from hyper-fs
+> - ❌: Not Supported Yet
 
-### Test
+### `readdir`
 
-With [ava](https://github.com/avajs/ava), run `yarn test/npm run test` to testing native addon. You can also switch to another testing framework if you want.
+- **Node.js Arguments**:
+  ```ts
+  path: string; // ✅
+  options?: {
+    encoding?: string; // ❌
+    withFileTypes?: boolean; // ✅
+    recursive?: boolean; // ✅
+  };
+  ```
+- **Return Type Diff**: `Buffer` return not supported yet.
+- **Performance**: TBD
+- **Supported Version**: TBD
+- **Notes**:
+  - ✨ Supports `options.concurrency` to control parallelism.
 
-### CI
+### `readFile`
 
-With GitHub Actions, each commit and pull request will be built and tested automatically in [`node@20`, `@node22`] x [`macOS`, `Linux`, `Windows`] matrix. You will never be afraid of the native addon broken in these platforms.
+- **Status**: ❌
 
-### Release
+### `writeFile`
 
-Release native package is very difficult in old days. Native packages may ask developers who use it to install `build toolchain` like `gcc/llvm`, `node-gyp` or something more.
+- **Status**: ❌
 
-With `GitHub actions`, we can easily prebuild a `binary` for major platforms. And with `N-API`, we should never be afraid of **ABI Compatible**.
+### `copyFile`
 
-The other problem is how to deliver prebuild `binary` to users. Downloading it in `postinstall` script is a common way that most packages do it right now. The problem with this solution is it introduced many other packages to download binary that has not been used by `runtime codes`. The other problem is some users may not easily download the binary from `GitHub/CDN` if they are behind a private network (But in most cases, they have a private NPM mirror).
+- **Status**: ❌
 
-In this package, we choose a better way to solve this problem. We release different `npm packages` for different platforms. And add it to `optionalDependencies` before releasing the `Major` package to npm.
+### `mkdir`
 
-`NPM` will choose which native package should download from `registry` automatically. You can see [npm](./npm) dir for details. And you can also run `yarn add @napi-rs/package-template` to see how it works.
+- **Status**: ❌
 
-## Develop requirements
+### `rm`
 
-- Install the latest `Rust`
-- Install `Node.js@10+` which fully supported `Node-API`
-- Install `yarn@1.x`
+- **Status**: ❌
 
-## Test in local
+### `rmdir`
 
-- yarn
-- yarn build
-- yarn test
+- **Status**: ❌
 
-And you will see:
+### `stat`
 
-```bash
-$ ava --verbose
+- **Status**: ❌
 
-  ✔ sync function from native code
-  ✔ sleep function from native code (201ms)
-  ─
+### `lstat`
 
-  2 tests passed
-✨  Done in 1.12s.
-```
+- **Status**: ❌
 
-## Release package
+### `fstat`
 
-Ensure you have set your **NPM_TOKEN** in the `GitHub` project setting.
+- **Status**: ❌
 
-In `Settings -> Secrets`, add **NPM_TOKEN** into it.
+### `access`
 
-When you want to release the package:
+- **Status**: ❌
 
-```bash
-npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=<prerelease-id>] | from-git]
+### `open`
+
+- **Status**: ❌
+
+### `opendir`
+
+- **Status**: ❌
+
+### `close`
+
+- **Status**: ❌
+
+### `unlink`
+
+- **Status**: ❌
+
+### `rename`
+
+- **Status**: ❌
+
+### `readlink`
+
+- **Status**: ❌
+
+### `realpath`
+
+- **Status**: ❌
+
+### `chmod`
+
+- **Status**: ❌
+
+### `chown`
+
+- **Status**: ❌
+
+### `utimes`
+
+- **Status**: ❌
+
+### `truncate`
+
+- **Status**: ❌
+
+### `appendFile`
+
+- **Status**: ❌
+
+### `watch`
+
+- **Status**: ❌
+
+## Usage
+
+```ts
+import { readdir } from 'hyper-fs'
+
+// Basic usage
+const files = await readdir('./src')
 
-git push
+// Recursive with file types
+const entries = await readdir('./src', {
+  recursive: true,
+  withFileTypes: true,
+})
 ```
 
-GitHub actions will do the rest job for you.
+## License
 
-> WARN: Don't run `npm publish` manually.
+MIT