mirror of
https://github.com/tauri-apps/plugins-workspace.git
synced 2026-07-24 17:20:51 +02:00
docs: update README.md and remove allowlist information (#381)
This commit is contained in:
committed by
GitHub
parent
d677f73495
commit
f4069f5588
+12
-2
@@ -1,4 +1,4 @@
|
||||
# Operating system plugin
|
||||
# Operating System
|
||||
|
||||
Read information about the operating system.
|
||||
|
||||
@@ -18,6 +18,8 @@ Install the Core plugin by adding the following to your `Cargo.toml` file:
|
||||
|
||||
```toml
|
||||
[dependencies]
|
||||
tauri-plugin-os = "2.0.0-alpha"
|
||||
# alternatively with Git:
|
||||
tauri-plugin-os = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }
|
||||
```
|
||||
|
||||
@@ -26,6 +28,13 @@ You can install the JavaScript Guest bindings using your preferred JavaScript pa
|
||||
> Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
|
||||
|
||||
```sh
|
||||
pnpm add @tauri-apps/plugin-os
|
||||
# or
|
||||
npm add @tauri-apps/plugin-os
|
||||
# or
|
||||
yarn add @tauri-apps/plugin-os
|
||||
|
||||
# alternatively with Git:
|
||||
pnpm add https://github.com/tauri-apps/tauri-plugin-os#v2
|
||||
# or
|
||||
npm add https://github.com/tauri-apps/tauri-plugin-os#v2
|
||||
@@ -51,7 +60,8 @@ fn main() {
|
||||
Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
|
||||
|
||||
```javascript
|
||||
import * as os from "@tauri-apps/plugin-os";
|
||||
import { version } from "@tauri-apps/plugin-os";
|
||||
const osVersion = await version();
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
@@ -5,19 +5,6 @@
|
||||
/**
|
||||
* Provides operating system-related utility methods and properties.
|
||||
*
|
||||
* The APIs must be added to [`tauri.allowlist.os`](https://tauri.app/v1/api/config/#allowlistconfig.os) in `tauri.conf.json`:
|
||||
* ```json
|
||||
* {
|
||||
* "tauri": {
|
||||
* "allowlist": {
|
||||
* "os": {
|
||||
* "all": true, // enable all Os APIs
|
||||
* }
|
||||
* }
|
||||
* }
|
||||
* }
|
||||
* ```
|
||||
* It is recommended to allowlist only the APIs you use for optimal bundle size and security.
|
||||
* @module
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user