Skip to content

Commit 2aa8389

Browse files
update: key features description in docs; add cool gifs (#39)
* update: key features description in docs * update: insert gifs * update: list of screenshots * remove: extra stuff about usage * update: add new preview
1 parent 5251b7d commit 2aa8389

File tree

6 files changed

+62
-33
lines changed

6 files changed

+62
-33
lines changed

README.md

+62-33
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,31 @@
22

33
<a src="https://www.npmjs.com/package/alfred-translayta"><img src="https://img.shields.io/npm/v/alfred-translayta?color=yellow" /></a>
44

5+
> **Translate** with Google Translate in Alfred (*en-uk* / *uk-en*). **Save** to favorites. Practice **learning** the words.
56
6-
> **Translate** with Google Translate in Alfred (*en-uk* / *uk-en*). **Save** to favorites. Finally, **learn** the words.
7+
<img width="800px" src="screenshots/preview.jpeg" />
78

8-
![](screenshots/dir.jpg)
9-
10-
Alfred Translayta is an Alfred workflow, which lets you easily translate 🇬🇧 to 🇺🇦, 🇺🇦 to 🇬🇧 pairs, add words to favorites and have convenient way to review and memorize them later.
9+
Alfred Translayta is an ***Alfred workflow***, which lets you easily translate 🇺🇦 🔄 🇬🇧 , save words to favorites and have convenient way to review and memorize them later.
1110

1211
## Features
1312
### Translation
14-
* Auto translate direction
15-
* Auto-correction of misspelled words
16-
* Get last translation details from the cache
17-
* Translate selected text in OS
13+
* ***Auto-detection*** of the translation direction
14+
* Correction of *misspelled words*
15+
* Foremost app ***selected text translation***
16+
* ***Pasting*** translation into the foremost app
17+
* ***Copying*** translation into the clipboard
18+
* ***Local caching*** of the last translation response
1819

1920
### Favorites
20-
* Add/Edit/Delete into favorites
21-
* Switch to learning mode
22-
* Search in normal/learning mode
23-
* Auto save favorites to a file on disk
21+
* *Add/Edit/Delete* favorites
22+
* *Learning* mode
23+
* *Search* through normal/learning mode
24+
* *Import/Export* favorites from/to local file
2425

2526
## Prerequisites
26-
You need [Node.js 14+](https://nodejs.org) and Alfred 3 or 4 with the paid [Powerpack](https://www.alfredapp.com/powerpack/) upgrade.
27+
* [Node.js 14](https://nodejs.org) or higher
28+
* [Alfred (3,4,5)](https://www.alfredapp.com/)
29+
* [Alfred Powerpack License](https://www.alfredapp.com/powerpack/)
2730

2831
## Install
2932
```
@@ -32,37 +35,63 @@ $ npm install --global alfred-translayta
3235

3336
## Usage
3437

35-
Open Alfred and type `t` **or** press `Cmd+Shift+K` and:
36-
* **to get translation**:
37-
- start typing words or phrases in English or Ukrainian
38-
* **to get previous translation from cache**:
39-
- press `spacebar`
40-
* **access the favorites**:
41-
- type `.`
42-
* **show favorites without translations(aka "learning mode")**:
43-
- type `..`
44-
- by pressing `Alt` button you can see translations of selected word
38+
Open Alfred and type `t` **or** press `Cmd+Shift+K` to activate workflow
4539

46-
## HotKeys
40+
<details><summary>Translate/Auto-correction</summary>
4741

48-
`Cmd+Shift+K` — to open workflow main window
42+
* start typing phrase in English or Ukrainian
4943

50-
`Cmd+Shift+J` — to open favorites list (shortcut for `Cmd+Shift+K` + and entered `.`)
44+
* hit `Enter` on list item with `auto-correction` suggestion
45+
46+
* enter ` ` (2 spaces) to get latest search results out of cache
47+
48+
* select any word of phrase and hit `Cmd-Shift-K` to get translation
49+
50+
![translate](https://user-images.githubusercontent.com/6503508/209795649-5709bbee-03d0-4ec9-9551-4c2b3f329b38.gif)
51+
</details>
52+
53+
54+
<details><summary>Copy/Paste</summary>
55+
56+
* navigate to any translation and hit `Enter` to copy to `clipboard`
57+
58+
* navigate to any translation and hit `Shift-Enter` to paste it into the `foremost` application
59+
60+
![copy_pasting](https://user-images.githubusercontent.com/6503508/209795746-3ae68798-ae0c-45d3-bcea-4cd67bb9e093.gif)
61+
</details>
5162

5263

53-
## Screenshots
64+
<details><summary>Favorites</summary>
5465

55-
**Auto** detection of **translation direction**
66+
* navigate to the item named `/add` and hit `Enter` to add word to `Favs`
5667

57-
![](screenshots/direction.jpg)
68+
* to get access to your `Favs` list enter `.` in workflow, aka `t .`
5869

59-
**Auto correction** of misspelled words
70+
* to edit/remove/copy any word from the list hit `Enter` on any item in your `Favs` list
6071

61-
![](screenshots/autocorrection.jpg)
6272

63-
**Learning Mode**
73+
![favs](https://user-images.githubusercontent.com/6503508/209795783-a8363c7f-30f4-4024-bd8b-102e0475f463.gif)
74+
</details>
6475

65-
https://user-images.githubusercontent.com/6503508/190931908-f900f9da-8299-43e9-bb10-633299b817ed.mov
76+
77+
<details><summary>Learning mode</summary>
78+
79+
* to activate learning mode for your `Favs`, enter `..`, aka `t ..`
80+
81+
* in both `Favs` and `Learning` modes you can search by typing after `..`,
82+
e.g. `t ..brick` or `t .. brick` will filter the list
83+
84+
* in `Learning` mode you can navigate to any item and press and hold `Option` key to make it's translation visible
85+
86+
![learning](https://user-images.githubusercontent.com/6503508/209795969-4bb2c246-bd55-4621-a10a-27e5542b74ef.gif)
87+
</details>
88+
89+
90+
## HotKeys
91+
92+
`Cmd+Shift+K` — to open workflow main window
93+
94+
`Cmd+Shift+J` — to open favorites list (shortcut for `Cmd+Shift+K` + and entered `.`)
6695

6796

6897
## Testimonials

screenshots/autocorrection.jpg

-99.5 KB
Binary file not shown.

screenshots/dir.jpg

-97.8 KB
Binary file not shown.

screenshots/direction.jpg

-78.4 KB
Binary file not shown.

screenshots/learning-mode.mov

-1.26 MB
Binary file not shown.

screenshots/preview.jpeg

83.7 KB
Loading

0 commit comments

Comments
 (0)