Skip to content

Commit 4dcd246

Browse files
author
tripleee
committed
README.md: fix English, typos, and formatting
Also, include a minimal JSON example Closes: matheusfaustino#10
1 parent 9ffe8e4 commit 4dcd246

File tree

1 file changed

+44
-15
lines changed

1 file changed

+44
-15
lines changed

README.md

+44-15
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,70 @@
11
# TextFast
2-
Have you aver felt boring in typing longs and tedious words or sentences every time when you want to reply a chat or created a post in reddit? This is addon is for you, it helps you type fast in a very customizable way in the browser.
2+
Have you aver felt bored from typing longs and tedious words or sentences
3+
every time when you want to reply a chat or created a post in Reddit?
4+
This addon is for you.
5+
It helps you type fast in a very customizable way in the browser.
36

4-
You can create shortcuts for words, setences or emoji and then type them in browser and write really fast.
5-
For instance: you can transform the phrase "I'm comming" into a shortcut "imc" and every time you time "imc" you will get "I'm comming". Another one? You can transform "¯\_[]_/¯" into "shrug" and then you will never mess up with the characters ever again.
7+
You can create shortcuts for words, sentences, or emoji,
8+
and then type them in the browser and write really fast.
9+
For instance: you can transform the phrase "I'm coming" into a shortcut "imc"
10+
and every time you time "imc" you will get "I'm coming".
11+
Another one? You can transform "shrug" into "¯\\_[]_/¯"
12+
and then you will never mess up with the characters ever again.
613

7-
All you have to do is to enter in the configuration page (click in the icon) and create a unique style of writing to you and then, save it and that is it.
14+
All you have to do is to enter the configuration page (click the icon)
15+
and create a unique style of writing to you and then save it, and that is it.
816

917
Good Luck, Have fun (typed: glhf)
1018

1119
## Why?
1220

13-
Well, I'm lazy to type and I don't like to type too much, so I want to be able to type fast even in the Firefox and all the websites that I use.
21+
Well, I'm lazy to type and I don't like to type too much,
22+
so I want to be able to type fast even in Firefox and
23+
all the websites that I use.
1424

1525

1626
## Configuration
1727

18-
When you installed the addon, it will add a new icon to the top bar, click there and you will be in the "configuration page" (I'll improve that, I hope, I'm not very good at design). Then, click in the "+" (plus) icon and it will create a new row in the list. Now, in the "Replace" column you will put shortcut to your boring word, sentence or emoji and in the "With" you will put the real word/sentence/emoji and then, click in Save. That is it, now go to google and just test it and then, add more shortcuts.
28+
When you install the addon, it will add a new icon to the top bar.
29+
Click there and you will be in the "configuration page"
30+
(I'll improve that, I hope, I'm not very good at design).
31+
Then, click the "+" (plus) icon and it will create a new row in the list.
32+
Now, in the "Replace" column you will put a shortcut for your boring
33+
word, sentence, or emoji,
34+
and in the "With" you will put the real word / sentence / emoji;
35+
and then, click Save.
36+
That is it, now go to google and just test it, and then add more shortcuts.
1937

2038
![Configuration Page](/screenshot.png)
2139

2240
### Import
2341

24-
Well, that it for the advanced users or the ones that exported the list from other installation (for who exported the list, you actually don have to change a thing, just import it, you can skip it). For those who don't want to add shortcut for shortcut, you can create a [JSON file](/example.json) following this example with your words and just import it and **save** it.
42+
For advanced users or if you exported the list from other installation
43+
(for who exported the list, you actually don't have to change a thing,
44+
just import it, you can skip it).
45+
For those who don't want to add shortcuts one by one,
46+
you can create a [JSON file](/example.json) following
47+
this example with your words and just import it and **save** it.
48+
49+
```
50+
[ {"replace": "foo", "with": "bar"},
51+
{"replace": "baz", "with": "quux"}]
52+
```
2553

2654
## Browsers
2755

28-
For now, I'm only focusing in the Firefox + webext. But, it will be cool to port it to others browsers and that is a good idea.
56+
For now, I'm only focusing on Firefox + webext.
57+
But it will be cool to port it to other browsers.
2958

3059
## TODO
3160

32-
- [x] Support dynamic inputs;
33-
- [ ] Support non-usual way to enter a text;
34-
- [x] Improve the UI of the list;
35-
- [ ] Use a better icon;
36-
- [ ] Sync your list with all your browsers;
37-
- [ ] Change the name (maybe).
61+
- [x] Support dynamic inputs
62+
- [ ] Support non-usual way to enter a text
63+
- [x] Improve the UI of the list
64+
- [ ] Use a better icon
65+
- [ ] Sync your list with all your browsers
66+
- [ ] Change the name (maybe)
3867

3968
## Do you want to help?
4069

41-
Well, see the TODO list and talk to me, I'm open for new ideas.
70+
See the TODO list and talk to me, I'm open to new ideas.

0 commit comments

Comments
 (0)