Skip to content

Commit 1c48c44

Browse files
authored
[add] add description to readme
1 parent 051e0b0 commit 1c48c44

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,31 @@
11
# round-robin
22
This module makes round-robin strings.
3+
4+
## Usage
5+
### Installation
6+
This module has no installer yet, so you can install only yourself.
7+
### Specification
8+
#### Constructor Arguments
9+
| name | type | description |
10+
| ------------------ |:----:| --------------------------------------------------------------|
11+
| any_characters | list | This list consolidate to character_list. |
12+
| use_all | bool | If it has True,  character_list has all aphabets and numbers. |
13+
| use_aphabets | bool | If it has True, character_list has all aphabets. |
14+
| use_small_aphabets | bool | If it has True, character_list has smaller aphabets. |
15+
| use_large_aphabets | bool | If it has True, character_list has larger aphabets. |
16+
| use_numbers | bool | If it has True, character_list has all numbers. |
17+
18+
19+
### Example
20+
This program continue getting round_robin strings from RoundRobin.next() and printing them.
21+
22+
```python
23+
import round_robin
24+
import time
25+
26+
roundrobin = round_robin.RoundRobin(use_all=True)
27+
28+
for pattern in roundrobin.next():
29+
print(pattern)
30+
time.sleep(0.1)
31+
```

0 commit comments

Comments
 (0)