search

ring0lab / catphish

CATPHISH project - For phishing and corporate espionage. Perfect for RED TEAM.
600 stars 120 forks source link

Improve README #85

Open picatz opened 7 years ago

picatz commented 7 years ago

I don't mind it all that much. But I think it could be a little more "friendly".

There's also been a little bit of talk on twitter about it; and I think we should take some of that constructive criticism and do something about it.

I opened this issue to document it and have an open discussion about it to help fix up the README all pretty like.

Ideas

I'm hoping current contributors ( and future contributors 😉 ) will add what they'd like to see included or be improved upon.

Some stuff I thought about to get the ball roll'n

ring0lab commented 7 years ago

I agreed, the README file needs to get improved for clarification on the methods and all things said above :+1:. This will give current and future contributors a stepping stone to work off it. We may need a wiki page that explains how to integrate new method algorithms into the current code. Let me know your thoughts on this. Also, having a changelog file would be a great idea.

ring0lab commented 7 years ago

@andrewhowdencom, changelog request merged.

picatz commented 7 years ago

@ring0lab A wiki page would be neat-o.

ghost commented 6 years ago

You can add legend for the flags, as example the -A flag add this if you desired catphish.txt

thank you