Improve README

[picatz]

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

• Logo?
• Explain Purpose / Typical Usage
• Improve Clarity of Method Behavior
• Explain Limitations
• Move changes to a changelog file of some sort?

[ring0lab]

I agreed, the README file needs to get improved for clarification on the methods and all things said above 👍. 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]

@andrewhowdencom, changelog request merged.

[picatz]

@ring0lab A wiki page would be neat-o.

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

thank you