CalvinBackup/tauri-plugins-workspace
1
0
Fork 0
mirror of https://github.com/tauri-apps/plugins-workspace.git synced 2026-09-22 21:30:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

fix(typo): fixed some language related issues in the documentation (#612)

Browse Source
This commit is contained in:
Praveen Ravichandran
2023-09-26 09:25:22 +03:00
committed by GitHub
parent b04bde3461
commit 44d8f60e0d
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/authenticator/README.md
+7 -7
View File
@@ -8,11 +8,11 @@ _This plugin requires a Rust version of at least **1.64**_
There are three general methods of installation that we can recommend. There are three general methods of installation that we can recommend.
1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked) 1. Use crates.io and npm (easiest and requires you to trust that our publishing pipeline worked)
2. Pull sources directly from Github using git tags / revision hashes (most secure) 2. Pull sources directly from Github using git tags / revision hashes (most secure)
3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use) 3. Git submodule install this repo in your tauri project and then use the file protocol to ingest the source (most secure, but inconvenient to use)
Install the Core plugin by adding the following to your `Cargo.toml` file: Install the authenticator plugin by adding the following lines to your `Cargo.toml` file:
`src-tauri/Cargo.toml` `src-tauri/Cargo.toml`
@@ -25,7 +25,7 @@ tauri-plugin-authenticator = { git = "https://github.com/tauri-apps/plugins-work
You can install the JavaScript Guest bindings using your preferred JavaScript package manager: You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
> 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. > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes the installation option 2, the most ergonomic to use.
```sh ```sh
pnpm add https://github.com/tauri-apps/tauri-plugin-authenticator#v1 pnpm add https://github.com/tauri-apps/tauri-plugin-authenticator#v1
@@ -37,7 +37,7 @@ yarn add https://github.com/tauri-apps/tauri-plugin-authenticator#v1
## Usage ## Usage
First you need to register the core plugin with Tauri: First, you need to register the authenticator plugin with Tauri:
`src-tauri/src/main.rs` `src-tauri/src/main.rs`
@@ -50,7 +50,7 @@ fn main() {
} }
``` ```
Afterwards all the plugin's APIs are available through the JavaScript guest bindings: Afterwards, all the plugin's APIs are available through the JavaScript guest bindings:
```javascript ```javascript
import { Authenticator } from "tauri-plugin-authenticator-api"; import { Authenticator } from "tauri-plugin-authenticator-api";
@@ -71,7 +71,7 @@ const domain = "https://tauri.app";
const json = await auth.register(challenge, domain); const json = await auth.register(challenge, domain);
const registerResult = JSON.parse(json); const registerResult = JSON.parse(json);
// verify the registration was successfull // verify the registration was successful
const r2 = await auth.verifyRegistration( const r2 = await auth.verifyRegistration(
challenge, challenge,
app, app,