From 30270802a32ecab99dc447cb2256b7ed0b5e2287 Mon Sep 17 00:00:00 2001 From: Alexis Glass Date: Sat, 18 Nov 2023 14:07:14 +0100 Subject: [PATCH] Add minimal mention of Wasm/TS support in docs --- README.md | 3 +++ docs/cli-usage.md | 8 ++++++++ 2 files changed, 11 insertions(+) diff --git a/README.md b/README.md index abe2e3c6..e995dce3 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ Djinni generator parses an interface definition file and generates: - Objective-C++ code to convert between C++ and Objective-C - Python and C code to convert between C++ and Python over CFFI - C++/CLI code to convert between C++ and C# +- C++ code to convert between WebAssembly and TS/JS ## Installation @@ -86,3 +87,5 @@ The code in this repository is in large portions copied from [dropbox/djinni](ht - Jacob Potter - Iulia Tamas - Andrew Twyman + +WebAssembly support is borrowed in large part from [snapchat/djinni](https://github.com/snapchat/djinni). \ No newline at end of file diff --git a/docs/cli-usage.md b/docs/cli-usage.md index b05d5bbf..3c27b842 100644 --- a/docs/cli-usage.md +++ b/docs/cli-usage.md @@ -145,6 +145,14 @@ djinni \ | `--cppcli-namespace ...` | The namespace name to use for generated C++/CLI classes. | | `--cppcli-include-cpp-prefix ` | The prefix for `#include` of the main C++ header files from C++/CLI files. | +### WebAssembly/TS/JS + +| Argument | Description | +|----------------------------------------|----------------------------------------------------------------------------| +| `--wasm-out ` | WebAssembly bridge code output folder | +| `--ts-out ` | Path to the Typescript type definitions output folder | +| `--ts-module ` | Name of the module for the Typescript types. `module.ts` by default. | + ### Yaml Generation