Skip to content

Commit e3aeb93

Browse files
committed
updated readme with examples
1 parent 48fdeb9 commit e3aeb93

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,29 @@ instead of being completely random
1616

1717
**vid_provided(_vid bytes_)** - specify the VID bytes when calling the function.
1818
Random device bytes will be generated.
19+
20+
Usage
21+
-----
22+
23+
Import and set up an object.
24+
`
25+
import generate_mac
26+
g = generate_mac.generate_mac
27+
`
28+
Procedurely generated Vendor and Host bytes. Checks for broadcast bit
29+
`g.total_random()`
30+
'12:7E:C4:B5:F1:8E'
31+
32+
Read Vendor bytes from random line in a file. This has to be formated the same
33+
as wireshark's manuf file.
34+
`g.vid_file_random('/usr/share/wireshark/manuf'`
35+
'00:55:DA:10:FB:D8'
36+
37+
Read from a manuf file like above, but find Vendor bytes belonging to a specific
38+
vendor, by name.
39+
`g.vid_file_vendor('/usr/share/wireshark/manuf', 'Apple')`
40+
'94:0C:98:BC:74:1C'
41+
42+
Provide the vendor bytes in a string. Generate Host bytes only
43+
`g.vid_provided('AA:BB:CC')`
44+
'AA:BB:CC:B8:B3:01'

0 commit comments

Comments
 (0)