Skip to content
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

add overview section to README #63

Open
fhocutt opened this issue Jul 24, 2014 · 0 comments
Open

add overview section to README #63

fhocutt opened this issue Jul 24, 2014 · 0 comments

Comments

@fhocutt
Copy link

fhocutt commented Jul 24, 2014

Add a short overview section to the documentation to provide new users with an idea of the structure and possible uses of the library and add context to the RDoc--this would go well near the list of features at the beginning of the README.

ETA: This would be a good place to state how much of the API functionality the library currently exposes.

@blackwinter blackwinter added this to the MediaWiki "gold standard" milestone Oct 23, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants