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

docs(readme): reformat readme to common style #844

Merged
merged 1 commit into from
Oct 16, 2016

Conversation

keithamus
Copy link
Member

This reformats the readme to be closer to the standard we're using in other projects. I've tweaked the badges a bit - for example it now features the supported node version (from the engines.node key in the released package.json, so for now it says >=0.4.0 but 4.0 will say >=0.10.0). I'll update the other READMEs to the same style after this.

This also closes #124

[![Slack Status](https://chai-slack.herokuapp.com/badge.svg)]( https://chai-slack.herokuapp.com/)
[![Join the chat at https://gitter.im/chaijs/chai](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/chaijs/chai)
[![OpenCollective](https://opencollective.com/chaijs/backers/badge.svg)](https://opencollective.com/chaijs)
Chai is an _assertion library_, similar to Node's build in `assert`. It makes testing much easier by giving you lot's of assertions you can run against your code.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*lots

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😊

@lucasfcosta
Copy link
Member

lucasfcosta commented Oct 16, 2016

LGTM (looks great to me!)
But let's just fix that lots typo and we will be ready to merge 😄

@keithamus
Copy link
Member Author

Fixed the typo @meeber @lucasfcosta 😊

@meeber
Copy link
Contributor

meeber commented Oct 16, 2016

LGTM

@meeber meeber merged commit a0154fe into chaijs:master Oct 16, 2016
@keithamus keithamus deleted the rework-readme branch October 16, 2016 21:17
@meeber meeber mentioned this pull request Oct 17, 2016
@leggsimon
Copy link

Goddammit @keithamus I told you I was gonna do this on Friday! 😆

@meeber
Copy link
Contributor

meeber commented Oct 17, 2016

Wowwwwwww I always knew that keithamoose fellow was shady but I thought there were limits to his nefarious behavior. Guess I was wrong!

@keithamus
Copy link
Member Author

@leggsimon I am not responsible for the things I remember or don't remember under the influence of alcohol. That's my excuse.

@leggsimon
Copy link

leggsimon commented Oct 17, 2016

🍻
Not a problem mate I guess I'll have to start my OS adventure with something harder 🙄

(Also your one does look better than mine)

@keithamus
Copy link
Member Author

Ooh @leggsimon I have a good one for you: chaijs/chai-http#43 - should be a good one to tackle and would also be helpful for simplifying the tests for the FT CDN!

@lucasfcosta
Copy link
Member

Also @leggsimon, if you want help or need any "guided tour" through the code feel free to ask me for it!
😄

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.

Document supported browsers
4 participants