Skip to content

Commit 05cd449

Browse files
committed
EDIT: new usage and special's added
1 parent dc959c9 commit 05cd449

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
# PyPoet
2-
Python library for playing with words.
2+
Python library for playing with words, one word at a time.
33

44
## Usage
55

66
#### Help Usage
77

88
```console
9-
usage: script.py [-h] [-r] [-s] [-a] [-m] [-hp] [-hg] [-sa] [-n NUMBER] word
9+
gavy42@jarvis:~/PyPoet$ python3 script.py -h
10+
usage: script.py [-h] [-r] [-s] [-a] [-m] [-hp] [-hg] [-sa] [-n NUMBER] [-f]
11+
word
1012

11-
PyPoet: Play with words
13+
PyPoet: Play with words, one word at a time.
1214

1315
positional arguments:
1416
word an input of the word
@@ -21,9 +23,10 @@ optional arguments:
2123
-m, --meaning get meaning
2224
-hp, --homophones get homophones
2325
-hg, --homographs get homographs
24-
-sa, --sounds_alike get words that sounds alike
26+
-sa, --sound_alike get words that sound alike
2527
-n NUMBER, --number NUMBER
2628
number of words should be returned
29+
-f, --full FULL lexical analysis
2730
```
2831

2932
#### Interpreter Usage
@@ -52,5 +55,17 @@ After creating an object instance as `Poet(<string>)`, these functions are avail
5255
- `antonyms()` : Returns a list of antonyms
5356
- `meaning()` : Returns a list of possible meanings
5457
- `homophones()` : Returns a list of homophones
55-
- 'homographs()' : Returns a list of homographs
56-
- 'sound_alike()' : Returns a list of words that sound alike the given word
58+
- `homographs()` : Returns a list of homographs
59+
- `sound_alike()` : Returns a list of words that sound alike the given word
60+
61+
## PyPoet's Special
62+
63+
- run `python3 script.py <word> -f` to get full lexical analysis of any word, in JSON format
64+
65+
```console
66+
gavy42@jarvis:~/PyPoet$ python3 script.py alone -f
67+
[!][!] Starting full analysis of: alone
68+
69+
[*][*] JSON file saved in local directory named - alone_lex_analysis.json
70+
71+
```

0 commit comments

Comments
 (0)