amaro 0.0.3 → 0.0.5

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Marco Ippolito
+Copyright (c) Marco Ippolito and Amaro contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -11,9 +11,43 @@ The main goal of this package is to provide a stable API for TypeScript parser,
 To install Amaro, run:
 
 ```shell
-npm install -g amaro
+npm install amaro
 ```
 
+## How to Use
+
+By default Amaro exports a `transformSync` function that performs type stripping.
+Stack traces are preserved, by replacing removed types with white spaces.
+
+```javascript
+const amaro = require('amaro');
+const { code } = amaro.transformSync("const foo: string = 'bar';");
+console.log(code); // "const foo         = 'bar';"
+```
+
+### How to update SWC
+
+To update the SWC version, run:
+
+```shell
+./tools/update-swc.sh
+git add deps
+git commit -m "chore: update swc to vX.Y.Z"
+```
+
+Once you have updated the rust source code we must build the wasm.
+To build the wasm it is necessary to have Docker installed.
+
+```shell
+node ./tools/build-wasm.js
+git add lib
+git commit -m "chore: build wasm from swc vX.Y.Z"
+```
+
+### TypeScript Version
+
+The supported TypeScript version is 5.5.4.
+
 ## License (MIT)
 
 See [`LICENSE.md`](./LICENSE.md).