Skip to content

Commit 0cf230a

Browse files
committed
Update readme to v1.0
1 parent cc8f989 commit 0cf230a

File tree

1 file changed

+44
-2
lines changed

1 file changed

+44
-2
lines changed

README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,44 @@
1-
# mentalist
2-
Mentalist is a graphical tool for custom wordlist generation. It utilizes common human paradigms for constructing passwords and can output the full wordlist as well as rules compatible with Hashcat and John the Ripper.
1+
![Version 1.0](http://img.shields.io/badge/version-v1.0-orange.svg)
2+
![Python 3.6](http://img.shields.io/badge/python-3.6-blue.svg)
3+
![MIT License](http://img.shields.io/badge/license-MIT%20License-blue.svg)
4+
[![sc0tfree Twitter](http://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Follow)](https://twitter.com/sc0tfree)
5+
6+
# Mentalist
7+
<p align="center">
8+
<img src="https://sc0tfree.squarespace.com/s/Mentalist-logo-250px.png" alt="Logo"/>
9+
</p>
10+
<br>
11+
12+
Mentalist is a graphical tool for custom wordlist generation. It utilizes common human paradigms for constructing passwords and can output the full wordlist as well as rules compatible with [Hashcat](https://hashcat.net/hashcat) and [John the Ripper](http://www.openwall.com/john).
13+
<br>
14+
15+
For more information on installing and using Mentalist, please **[visit the wiki](https://www.github.com/sc0tfree/mentalist/wiki)**.
16+
17+
<br>
18+
<p align="center">
19+
<img src="https://sc0tfree.squarespace.com/s/mentalist-readme-gui.gif" alt="Mentalist GUI"/>
20+
</p>
21+
22+
To get up and running quickly, download a prebuilt executable on the [releases page](https://github.com/sc0tfree/mentalist/releases).
23+
24+
## Disclaimer
25+
26+
Mentalist should be used only for **informational purposes** or on **authorized system audits**. _Do not use this tool to aid in illicit access to a system._
27+
28+
## License and Contributions
29+
30+
Mentalist is under the MIT License.
31+
32+
Contributions are always welcomed! Please let me know if there's a specific piece of functionality that you'd like to see built-in to the next version of Mentalist.
33+
34+
## Thanks
35+
36+
A special thanks to Craig Baker, who was instrumental in helping to develop the backend logic of Mentalist. Additionally, thank you to Shane Carlyon, whose Tkinter-fu was invaluable, and to Gregory Brewer, who contributed the artwork to this project.
37+
38+
## Future Work
39+
40+
* Ability to scrape sites as an attribute in the Base Words node.
41+
* Add dictionaries and lists for more languages
42+
* Add UK post codes to Append/Prepend Nodes
43+
* Option to perform de-duplication of Base Words
44+
* Mentalist Chain file differencing

0 commit comments

Comments
 (0)