Add simple readme and rename APIs

javascript/README.md

@@ -0,0 +1,25 @@
+# yoga-layout
+
+This package provides JavaScript bindings for the Yoga layout engine as either WebAssembly (for browsers, Node) or asm.js (other clients or clients unable to read package export maps).
+
+## Usage
+
+The default entrypoint provides an asynchronous loader function to return a Yoga instance.
+
+```ts
+import { loadYoga, ALIGN_CENTER } from "yoga-layout";
+
+const Yoga = await loadYoga();
+
+const node = Yoga.Node.create();
+node.setAlignContent(ALIGN_CENTER);
+```
+
+An alternative synchronous API is provided for compatibility, but requires using asm.js in browsers instead of WebAssembly, leading to worse performance and larger assets.
+
+```ts
+import Yoga, { ALIGN_CENTER } from "yoga-layout/sync";
+
+const node = Yoga.Node.create();
+node.setAlignContent(ALIGN_CENTER);
+```

javascript/jest.setup.js

@@ -13,8 +13,8 @@ module.exports = async () => {
   } else if (process.env['SYNC']) {
     global.Yoga = require("./dist/sync.asmjs");
   } else if (process.env['WASM']) {
-    global.Yoga = await require("./dist/index.wasm").load();
+    global.Yoga = await require("./dist/index.wasm").loadYoga();
   } else {
-    global.Yoga = await require("./dist/index.asmjs").load();
+    global.Yoga = await require("./dist/index.asmjs").loadYoga();
   }
 }

javascript/sources/index.asmjs.js

@@ -8,9 +8,9 @@
  */
 
 const wrapAsm = require('./wrapAsm');
-const loadYoga = require('./asmjs-async');
+const loadAsm = require('./asmjs-async');
 
 module.exports = {
-  load: () => loadYoga().then(wrapAsm),
+  loadYoga: () => loadAsm().then(wrapAsm),
   ...require('./YGEnums'),
 }

javascript/sources/index.d.ts

@@ -12,4 +12,4 @@ import type {Yoga} from './wrapAsm';
 export * from './YGEnums';
 export * from './wrapAsm';
 
-export function load(): Promise<Yoga>;
+export function loadYoga(): Promise<Yoga>;

javascript/sources/index.wasm.js

@@ -8,9 +8,9 @@
  */
 
 const wrapAsm = require('./wrapAsm');
-const loadYoga = require('./wasm-async');
+const loadAsm = require('./wasm-async');
 
 module.exports = {
-  load: () => loadYoga().then(wrapAsm),
+  loadYoga: () => loadAsm().then(wrapAsm),
   ...require('./YGEnums'),
 }

javascript/sources/sync.asmjs.js

@@ -8,6 +8,6 @@
  */
 
 const wrapAsm = require('./wrapAsm');
-const loadYoga = require('./asmjs-sync');
+const loadAsm = require('./asmjs-sync');
 
-module.exports = wrapAsm(loadYoga());
+module.exports = wrapAsm(loadAsm());

javascript/sources/sync.wasm.js

@@ -8,6 +8,6 @@
  */
 
 const wrapAsm = require('./wrapAsm');
-const loadYoga = require('./wasm-sync');
+const loadAsm = require('./wasm-sync');
 
-module.exports = wrapAsm(loadYoga());
+module.exports = wrapAsm(loadAsm());