Skip to content

Commit

Permalink
fix(typo): fixed some language related issues in the documentation (#612
Browse files Browse the repository at this point in the history
)
  • Loading branch information
pravinba9495 authored Sep 26, 2023
1 parent b04bde3 commit 44d8f60
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions plugins/authenticator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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)
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`

Expand All @@ -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:

> 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
pnpm add https://github.com/tauri-apps/tauri-plugin-authenticator#v1
Expand All @@ -37,7 +37,7 @@ yarn add https://github.com/tauri-apps/tauri-plugin-authenticator#v1

## 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`

Expand All @@ -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
import { Authenticator } from "tauri-plugin-authenticator-api";
Expand All @@ -71,7 +71,7 @@ const domain = "https://tauri.app";
const json = await auth.register(challenge, domain);
const registerResult = JSON.parse(json);

// verify the registration was successfull
// verify the registration was successful
const r2 = await auth.verifyRegistration(
challenge,
app,
Expand Down

0 comments on commit 44d8f60

Please sign in to comment.