Our README rocks! It's very complete and clear in every sense, but I think it's a bit too complete.
At least in my opinion a README file should only summarise what the project is about, how to install it, give like 1 or 2 examples, who are the project administrators and how to contribute.
Since this file already has examples for each of the methods we've created so far (or most of them maybe), we could simply move all this detailed information into a wiki, which again in my opinion I think is more appropriate for having detailed info.
Our README rocks! It's very complete and clear in every sense, but I think it's a bit too complete.
At least in my opinion a README file should only summarise what the project is about, how to install it, give like 1 or 2 examples, who are the project administrators and how to contribute.
Since this file already has examples for each of the methods we've created so far (or most of them maybe), we could simply move all this detailed information into a wiki, which again in my opinion I think is more appropriate for having detailed info.
What are your thoughts?