Skip to content

Commit ca5b8f0

Browse files
committed
update readme
1 parent d47c6e7 commit ca5b8f0

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,9 @@ Check out the examples folder for sample usage.
4141

4242
[Read more here](https://zackoverflow.dev/writing/tsgql).
4343

44-
This is an experimental internal tool we use at Modfy, and is subject to breaking changes and general instability.
44+
## How it works
45+
tsgql uses SWC to parse your Typescript schema into an AST, which is then walked and used to generate a GraphQL schema with [apollo-encoder](https://github.com/apollographql/apollo-rs/tree/main/crates/apollo-encoder).
46+
47+
Before the SWC step, we run your Typescript types through the TS Compiler API, which reduces them into a simpler form. This is necessary because SWC provides no such type system utilities.
48+
49+
This is an experimental internal tool we use at Modfy, and is subject to breaking changes and general instability.

0 commit comments

Comments
 (0)