Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Tidy README.md, fix nitpicks and add badges #142

Merged
merged 1 commit into from
Jul 3, 2017
Merged

Tidy README.md, fix nitpicks and add badges #142

merged 1 commit into from
Jul 3, 2017

Conversation

hassankhan
Copy link
Contributor

@hassankhan hassankhan commented Jul 2, 2017

What did you implement:

Closes #141

How did you implement it:

Updated README.md.

How can we verify it:

Viewing README.md.

Todos:

  • Write tests
  • Write documentation
  • Fix linting errors (not yet implemented)
  • Make sure code coverage hasn't dropped (not yet implemented)
  • Provide verification config / commands / resources
  • Enable "Allow edits from maintainers" for this PR
  • Update the messages below

Is this ready for review?: YES
Is it a breaking change?: NO

[![CircleCI](https://circleci.com/gh/elastic-coders/serverless-webpack.svg?style=shield)](https://circleci.com/gh/elastic-coders/serverless-webpack)
[![Serverless][ico-serverless]][link-serverless]
[![CircleCI][ico-circleci]][link-circleci]
[![NPM][ico-npm]][link-npm]
Copy link
Member

Choose a reason for hiding this comment

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

npm version

Copy link
Member

Choose a reason for hiding this comment

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

Oops ... see my plugin for the source ;-)

Copy link
Member

@HyperBrain HyperBrain Jul 2, 2017

Choose a reason for hiding this comment

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

[![npm](https://img.shields.io/npm/dt/serverless-webpack.svg)](https://www.npmjs.com/package/serverless-webpack)
In general SVG render urls should be used.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The icons are already SVG unless I'm mistaken... if you check the bottom of README.md:

[ico-serverless]: http://public.serverless.com/badges/v3.svg
[ico-circleci]: https://img.shields.io/circleci/project/github/elastic-coders/serverless-webpack.svg
[ico-npm]: https://img.shields.io/npm/v/serverless-webpack.svg
[ico-contributors]: https://img.shields.io/github/contributors/elastic-coders/serverless-webpack.svg

Copy link
Member

Choose a reason for hiding this comment

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

;) Sorry ... did not read until the end.

@hassankhan hassankhan mentioned this pull request Jul 2, 2017
@HyperBrain HyperBrain merged commit 7893b9b into serverless-heaven:master Jul 3, 2017
@hassankhan hassankhan deleted the tidy-readme branch July 3, 2017 10:53
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update README.md
2 participants