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

Minor README improvements #208

Merged
merged 1 commit into from
Jul 22, 2015
Merged

Minor README improvements #208

merged 1 commit into from
Jul 22, 2015

Conversation

nexdrew
Copy link
Member

@nexdrew nexdrew commented Jul 22, 2015

I was reading over the docs recently and I noticed a couple problems, so I thought I'd attempt a bit of cleanup. Namely:

  • Fix a few spelling and grammatical mistakes (e.g. "retrived" -> "retrieved", "then" -> "than", etc)
  • Attempt to make content more consistent
  • Update examples with actual output from yargs v3.15.0

Hope this helps. 😉

@bcoe
Copy link
Member

bcoe commented Jul 22, 2015

@nexdrew thank you so much \o/

We could use a ton of help with the README.md, thanks for taking a first stab at the problem: see #92

bcoe added a commit that referenced this pull request Jul 22, 2015
@bcoe bcoe merged commit 8eb222f into yargs:master Jul 22, 2015
@nexdrew
Copy link
Member Author

nexdrew commented Jul 22, 2015

Thanks, Ben, I'll take a look. Overall, I think the documentation is pretty good, but I may have a couple ideas about how to better organize its content, roughly following the high-level outline you mention in #92. I'll move any further discussion there.

@nexdrew nexdrew deleted the yer-readme-be-jiggered branch July 22, 2015 19:23
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

Successfully merging this pull request may close these issues.

2 participants