Skip to content

Commit a8fdf92

Browse files
committed
README Improvements
1 parent f6dbadb commit a8fdf92

File tree

1 file changed

+23
-27
lines changed

1 file changed

+23
-27
lines changed

README.md

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,45 +5,43 @@
55

66
[![jetbrain](media/jetbrains.svg)](https://www.jetbrains.com/?from=alfred-google-translate)
77

8-
## Install
8+
## Installation
99

10-
*Requires [Node.js](https://nodejs.org) 8+ and the Alfred 3 or 4 [Powerpack](https://www.alfredapp.com/powerpack/).*
10+
*Requires the Alfred 3 or 4 [Powerpack](https://www.alfredapp.com/powerpack/), [Node.js](https://nodejs.org) 8+, and the [alfred-language-configuration](https://github.com/xfslove/alfred-language-configuration) workflow.*
1111

12-
- install with `npm install -g alfred-google-translate`
13-
- or [download](https://github.com/xfslove/alfred-google-translate/releases/tag/v2.0.8) workflow
12+
To use this workflow you must also install the [alfred-language-configuration](https://github.com/xfslove/alfred-language-configuration) workflow, and configure the language pair. See that [README](https://github.com/xfslove/alfred-language-configuration) for instructions.
1413

15-
## [Changelog](https://github.com/xfslove/alfred-google-translate/releases)
14+
### With NPM
15+
- Install with `npm install -g alfred-google-translate`.
1616

17-
## Usage
18-
19-
Before using this workflow, You must config the language pair. see [alfred-language-configuration](https://github.com/xfslove/alfred-language-configuration), (**The Language Auto Detected** btw, [#36](https://github.com/xfslove/alfred-google-translate/issues/36))
20-
21-
Alfred workflow Keyword `tr`.
17+
### Manually
18+
- Or [download the workflow directly](https://github.com/xfslove/alfred-google-translate/releases/tag/v2.0.8).
2219

23-
the shown items explain:
20+
## Changelog
21+
See [all past and current releases](https://github.com/xfslove/alfred-google-translate/releases).
2422

25-
The first item is input word or sentence (webster phonetic if avaliable).
26-
27-
The second item is translation of input (webster phonetic if avaliable).
23+
## Usage
2824

29-
The rest of items are Definitions and Translations of input.
25+
Alfred workflow Keyword: `tr [word or sentence]`
26+
Example: `tr kitchen sink` or `tr Hello, my name is Alfred`
3027

31-
at the first and second item You can:
28+
When translating a word you will see the translation as well as alternate translations if available.
3229

30+
With the first two results (which are the input word and the translation) you can…
3331
- press <kbd>enter</kbd> to read the item.
3432
- press <kbd>cmd</kbd>+<kbd>C</kbd> to copy the item.
3533
- press <kbd>shift</kbd> open the translate website.
36-
- press <kbd>cmd</kbd>+<kbd>L</kbd> to see the full content.
34+
- press <kbd>cmd</kbd>+<kbd>L</kbd> to show the translation in large text.
3735

38-
if You input wrong word, the workflow will correct your input, and You can press <kbd>enter</kbd> to see.
36+
The workflow will attempt to correct spelling mistakes which can be accepted with <kbd>enter</kbd>.
3937

4038
## Environment Variables
4139

4240
| name | default value | description |
4341
| ---------- | ---------------------------- | ------------------------------------------------------------ |
4442
| domain | https://translate.google.com | if you cannot access the default domain, you can config this. <br />大陆访问不了默认域名,所以如果使用2.x版本需要将这个变量设置为https://translate.google.cn. 或者还是使用[1.x版本](https://github.com/xfslove/alfred-google-translate/tree/v1.x) |
45-
| voice | remote | avaliable values: <br />remote: fetch voice from google, <br />local: use macOS local voice (notice: maybe only works on English),<br />none: dont get voice |
46-
| save_count | 20 | limit count of translate history, see [alfred-translate-history](https://github.com/xfslove/alfred-translate-history). <br />0 means dont save translate history |
43+
| voice | remote | avaliable values: <br />remote: fetch voice from google, <br />local: use macOS local voice (notice: maybe only works on English),<br />none: dont use voice |
44+
| save_count | 20 | limit the translation history, see [alfred-translate-history](https://github.com/xfslove/alfred-translate-history). <br />a value of 0 will keep no history |
4745

4846
##### environment variables config snapshot:
4947

@@ -53,7 +51,7 @@ if You input wrong word, the workflow will correct your input, and You can press
5351

5452
## Hotkey
5553

56-
if you download the workflow, you may lost the hotkey, so you can manual config this.
54+
If you download the workflow, you may have to manually set the hotkey yourself.
5755

5856
##### hotkey config snapshot:
5957

@@ -67,23 +65,21 @@ if you download the workflow, you may lost the hotkey, so you can manual config
6765

6866

6967

70-
## Snapshot
71-
72-
- correct
68+
## Screenshots
7369

7470
![](media/detect-lang.png)
7571

7672
![corrected.png](media/corrected.png)
7773

78-
- press <kbd>enter</kbd> to read,press<kbd>cmd</kbd>+<kbd>C</kbd> to copy
74+
- press <kbd>enter</kbd> to read or <kbd>cmd</kbd>+<kbd>C</kbd> to copy
7975

8076
![general.png](media/general.png)
8177

82-
- press <kbd>shift</kbd> to open translate website
78+
- press <kbd>shift</kbd> to open the translation website
8379

8480
![quicklook.png](media/quicklook.png)
8581

86-
- press <kbd>cmd</kbd>+<kbd>L</kbd> to show full content,like the [gif in hotkey](#hotkey-and-largetype-snapshot).
82+
- press <kbd>cmd</kbd>+<kbd>L</kbd> to show the translation in large text [like this](#hotkey-and-largetype-snapshot).
8783

8884
## Related
8985

0 commit comments

Comments
 (0)