Skip to content

Commit f83dc5c

Browse files
committed
chore: update readme
1 parent 8de8bd6 commit f83dc5c

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ Cap’n Proto is an insanely fast data interchange format and capability-based R
1818

1919
## Usage
2020

21+
### Compiling schema
22+
2123
Make sure `capnpc` command is available. You can find install instructions [here](https://capnproto.org/install.html) to install it.
2224

2325
Run the following to compile a schema file into typeScript/javascript source code:
@@ -67,7 +69,7 @@ This project is a rework<sup>1</sup> of [jdiaz5513/capnp-ts](https://github.com/
6769
- [x] Enums are typed plain JS objects (this way `.ts` files work with strip-only ts loaders without enum support.)
6870
- [x] Compiler CLI can directly accept a path to `.capnp` files and internally use `capnpc`
6971
- [ ] [WIP] Use reflection (getter setters) to access structs.
70-
- [ ] [TODO] Investigate runtime performance. Some language features make full traverse slow. (especially on Node 20, Bun is fast and all good)
72+
- [ ] [TODO] Investigate runtime performance. Some language features make full traverse slow, especially on Node.js < 22, Bun is fast and all good.
7173
- [ ] [PLANNED] Investigate RPC level 1 (some progress [here](https://github.com/jdiaz5513/capnp-ts/pull/169))
7274
- [ ] [PLANNED] Investigate the possibility of bundling the wasm version of `capnp`
7375

0 commit comments

Comments
 (0)