-
Notifications
You must be signed in to change notification settings - Fork 5
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
Document how to use the wrapper in an app #6
Comments
Begun this here by:
|
Having an example app is always nice, and we actually already have an example app in development in the human_services_finder repo. The demo branch feels like we're duplicating efforts. I would prioritize listing all the available methods and their parameters in the README or Wiki. As an MVP, I would generate the docs with RubyDoc.info |
@monfresh I agree with RubyDoc.info, would it be too early to add the project URL? I'd advocate keeping the demo branch for now, it has the advantage that the wrapper can be tested in use in the same repository its created, and it's a barebones example that just contains calls to the wrapper, as opposed to the HSF, which has multiple views and controllers. I really created it to ease the documentation workflow, as one can make a change to the wrapper, switch to the demo branch to create an implementation example and then add that to the wiki. Switching between the wrapper repo and HSF repo isn't as smooth a workflow. |
The README should include Configuration and Usage Examples. Here's a good API wrapper README: https://github.com/sferik/twitter
The text was updated successfully, but these errors were encountered: