Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README #85

Open
picatz opened this issue Jun 25, 2017 · 4 comments
Open

Improve README #85

picatz opened this issue Jun 25, 2017 · 4 comments

Comments

@picatz
Copy link
Contributor

picatz commented Jun 25, 2017

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
Copy link
Owner

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
Copy link
Owner

@andrewhowdencom, changelog request merged.

@picatz
Copy link
Contributor Author

picatz commented Jul 2, 2017

@ring0lab A wiki page would be neat-o.

@ghost
Copy link

ghost commented Mar 27, 2018

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

thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants