Skip to content

Commit

Permalink
updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
@OvidijusParsiunas
OvidijusParsiunas committed Dec 20, 2024
1 parent 1355fab commit 6d8910c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
18 changes: 9 additions & 9 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,15 +116,15 @@ https://github.com/OvidijusParsiunas/speech-to-element/assets/18709577/cca6bc40-

Object used to set the phrases of commands that will control transcription and input functionality:

| Name | Type | Description |
| :------------ | :------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------ |
| stop | `string` | Stop the speech service |
| pause | `string` | Temporarily stops the transcription and re-enables it after the phrase for `resume` is spoken. |
| resume | `string` | Re-enables transcription after it has been stopped by the `pause` or `commandMode` commands. |
| reset | `string` | Remove the transcribed text (since the last element cursor move) |
| removeAllText | `string` | Remove all element text |
| commandMode | `string` | Activate the command mode which will stops transcription and waits for a command to be executed. Use the phrase for `resume` to leave the command mode. |
| settings | [`CommandSettings`](#commandsettings) | Controls how command mode is used. |
| Name | Type | Description |
| :------------ | :------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------- |
| stop | `string` | Stop the speech service |
| pause | `string` | Temporarily stops the transcription and re-enables it after the phrase for `resume` is spoken. |
| resume | `string` | Re-enables transcription after it has been stopped by the `pause` or `commandMode` commands. |
| reset | `string` | Remove the transcribed text (since the last element cursor move) |
| removeAllText | `string` | Remove all element text |
| commandMode | `string` | Activate the command mode which will stop the transcription and wait for a command to be executed. Use the phrase for `resume` to leave the command mode. |
| settings | [`CommandSettings`](#commandsettings) | Controls how command mode is used. |

Example:

Expand Down
18 changes: 9 additions & 9 deletions component/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,15 +129,15 @@ https://github.com/OvidijusParsiunas/speech-to-element/assets/18709577/cca6bc40-

Object used to set the phrases of commands that will control transcription and input functionality:

| Name | Type | Description |
| :------------ | :------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------ |
| stop | `string` | Stop the speech service |
| pause | `string` | Temporarily stops the transcription and re-enables it after the phrase for `resume` is spoken. |
| resume | `string` | Re-enables transcription after it has been stopped by the `pause` or `commandMode` commands. |
| reset | `string` | Remove the transcribed text (since the last element cursor move) |
| removeAllText | `string` | Remove all element text |
| commandMode | `string` | Activate the command mode which will stops transcription and waits for a command to be executed. Use the phrase for `resume` to leave the command mode. |
| settings | [`CommandSettings`](#commandsettings) | Controls how command mode is used. |
| Name | Type | Description |
| :------------ | :------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------- |
| stop | `string` | Stop the speech service |
| pause | `string` | Temporarily stops the transcription and re-enables it after the phrase for `resume` is spoken. |
| resume | `string` | Re-enables transcription after it has been stopped by the `pause` or `commandMode` commands. |
| reset | `string` | Remove the transcribed text (since the last element cursor move) |
| removeAllText | `string` | Remove all element text |
| commandMode | `string` | Activate the command mode which will stop the transcription and wait for a command to be executed. Use the phrase for `resume` to leave the command mode. |
| settings | [`CommandSettings`](#commandsettings) | Controls how command mode is used. |

Example:

Expand Down

0 comments on commit 6d8910c

Please sign in to comment.