@rescript/webapi 0.1.0-experimental-32f15eb → 0.1.0-experimental-bef77c9

package/README.md

@@ -1,14 +1,30 @@
+[![NPM Version](https://img.shields.io/npm/v/%40rescript%2Fwebapi)](https://www.npmjs.com/package/@rescript/webapi)
+
 # experimental-rescript-webapi
+
 Experimental successor to [rescript-webapi](https://github.com/TheSpyder/rescript-webapi)
 
-## New approach to webapi bindings (TODO)
+## Getting started
+
+Install the package using your favorite package manager:
+
+```shell
+npm i -D @rescript/webapi@experimental
+```
+
+and add `@rescript/webapi` to your `rescript.json`:
 
-1. Find out if it is possible to adapt https://github.com/microsoft/TypeScript-DOM-lib-generator to output `.res` files
-  - One example output is here: https://github.com/microsoft/TypeScript/blob/main/src/lib/dom.generated.d.ts
-2. Try to type most things with records with which we can model inheritance, but for readability and performance's sake it will be better to keep type spread and the necessity for coercion at a minimum and rather duplicate field names (which should not be a problem when everything is generated) as well as identity functions (coercion can be expensive with big record fields).
-3. 80/20 approach, we want to model the more common APIs in a way so that they are delightful to use while the more obscure ones can be harder to use, but those should still be documented well.
-4. In essence, we apply the rescript-core way of doing things here once again, so doc tests can be implemented as well.
+```json
+{
+  "bs-dependencies": [
++    "@rescript/webapi",
+  ],
+  "bsc-flags": [
++    "-open Global"
+  ]
+}
+```
 
-## TypeScript-DOM-lib-generator
+## Documentation
 
-The repository [TypeScript-DOM-lib-generator](https://github.com/microsoft/TypeScript-DOM-lib-generator) was originally forked into [nojaf/TypeScript-DOM-lib-generator](https://github.com/nojaf/TypeScript-DOM-lib-generator/tree/rescript) but has since been copied into `tools/TypeScript-DOM-lib-generator` for easier collaboration.
+More information can be found on https://rescript-lang.github.io/experimental-rescript-webapi/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rescript/webapi",
-  "version": "0.1.0-experimental-32f15eb",
+  "version": "0.1.0-experimental-bef77c9",
   "description": "Experimental successor to [rescript-webapi](https://github.com/TheSpyder/rescript-webapi)",
   "homepage": "https://github.com/rescript-lang/experimental-rescript-webapi",
   "bugs": "https://github.com/rescript-lang/experimental-rescript-webapi/issues",