-
Notifications
You must be signed in to change notification settings - Fork 4
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
Docs directory is looking a bit bare #8
Comments
Oh another thought: It would be nice to ship the README in the artifacts. I spent a few weeks without internet access earlier this year and I wish all the modules I used shipped READMEs in their jars :) |
I'd agree with having more docs, particularly some examples, as I find them to be generally more useful than a page full of function doc-strings. Maybe a one-page "Getting Started" walkthrough would be a good candidate to start? |
Yeah, that sounds like a good idea. I'll ping you when my release manager has got the first release of utrecht out the door. |
utrecht 0.2.0 hit clojars last night! |
At the minute, I'd say the README is doing a better job. It might be nice to include a few fully working basic examples in an 'examples' directory, but I don't think we can add much more value by having just markdown, given the "gets out of your way" nature of the library.
I think the best value from this module is given in conjunction with utrecht and this might make a nice base for samples.
Thoughts?
The text was updated successfully, but these errors were encountered: