As this library grows, trying to document everything in the top level README file will become overbearing. The top-level README should be trimmed down to the following major sections: Requirements, Installation, Usage, Credits, License.
The Usage section itself can contain a link to the full set of documentation generated based on doc comments. It should also have a very limited set of actual code snippets demonstrating the usage of the library. For this, we should determine what are the most popular or appealing aspects of the library and document these there. This section should contain some prose about who this library is meant for, what you can accomplish with it, etc. Then, this section should also link out to more complete & detailed documentation, including multiple example code snippets for each chunk of the total library. Consider Alamofire's Documentation directory as a guideline toward the direction we should be looking at. However, I imagine each chunk of MetovaTestKit having its own markdown file with documentation. The top-level README can then link straight to each of these individual files.
As this library grows, trying to document everything in the top level README file will become overbearing. The top-level README should be trimmed down to the following major sections: Requirements, Installation, Usage, Credits, License.
The Usage section itself can contain a link to the full set of documentation generated based on doc comments. It should also have a very limited set of actual code snippets demonstrating the usage of the library. For this, we should determine what are the most popular or appealing aspects of the library and document these there. This section should contain some prose about who this library is meant for, what you can accomplish with it, etc. Then, this section should also link out to more complete & detailed documentation, including multiple example code snippets for each chunk of the total library. Consider Alamofire's Documentation directory as a guideline toward the direction we should be looking at. However, I imagine each chunk of MetovaTestKit having its own markdown file with documentation. The top-level README can then link straight to each of these individual files.