List required fields? - Githubissues

joshfrench / rakismet

Easy Akismet and TypePad AntiSpam integration for Rails

MIT License

355 stars 46 forks source link

List required fields? #40

Closed pyro2927 closed 8 years ago

pyro2927 commented 8 years ago

Is it possible to list the required values in the README? I'm not a regular Akismet user, so it took a little bit of work and looking and the akismet_responses to figure out what fields were needed. As far as I can tell, the following values need to be populated:

author
author_email
content
user_ip
user_agent

Just thinking of how to make the gem more approachable from a novice's standpoint.

joshfrench commented 8 years ago

The Akismet API should be the documentation of reference, I'd rather not reproduce it here and then be responsible for keeping in step.