initial commit

README.md

@@ -0,0 +1,72 @@
+# tauri-sys
+
+Bindings to the [Tauri API] for projects using [wasm-bindgen]
+
+## Installation
+
+This crate is not yet published to crates.io, so you need to use it from git.
+You also need a global installation of [`esbuild`].
+
+```toml
+tauri-sys = { git = "https://github.com/JonasKruckenberg/tauri-sys" }
+```
+
+## Usage
+
+```rust
+use serde::{Deserialize, Serialize};
+use tauri_sys::tauri;
+
+#[derive(Serialize, Deserialize)]
+struct GreetArgs<'a> {
+    name: &'a str,
+}
+
+fn main() {
+    wasm_bindgen_futures::spawn_local(async move {
+        let new_msg: String = tauri::invoke("greet", &GreetArgs { name: &name.get() }).await.unwrap();
+
+        println!("{}", new_msg);
+    });
+}
+```
+
+## Features
+
+All modules are gated by accordingly named Cargo features. It is recommended you keep this synced with the features enabled in your [Tauri Allowlist] but no automated tool for this exists (yet).
+
+- **all**: Enables all modules.
+- **app**: Enables the `app` module.
+- **clipboard**: Enables the `clipboard` module.
+- **event**: Enables the `event` module.
+- **mocks**: Enables the `mocks` module.
+- **tauri**: Enables the `tauri` module.
+
+## Are we Tauri yet?
+
+These API bindings are not completely on-par with `@tauri-apps/api` yet, but here is the current status-quo:
+
+- [x] `app`
+- [ ] `cli`
+- [x] `clipboard`
+- [ ] `dialog`
+- [x] `event`
+- [ ] `fs`
+- [ ] `global_shortcut`
+- [ ] `http`
+- [x] `mocks`
+- [ ] `notification`
+- [ ] `os`
+- [ ] `path`
+- [ ] `process`
+- [ ] `shell`
+- [x] `tauri`
+- [ ] `updater`
+- [ ] `window`
+
+The current API also very closely mirrors the JS API even though that might not be the most ergonomic choice, ideas for improving the API with quality-of-life features beyond the regular JS API interface are very welcome.
+
+[Tauri API]: https://tauri.app/v1/api/js/
+[wasm-bindgen]: https://github.com/rustwasm/wasm-bindgen
+[Tauri Allowlist]: https://tauri.app/v1/api/config#allowlistconfig
+[`esbuild`]: https://esbuild.github.io/getting-started/#install-esbuild