From 85707575c3feb3fa81978b569bbbcc402e7675ac Mon Sep 17 00:00:00 2001 From: Brian Quinlan Date: Thu, 28 Jun 2018 10:10:58 -0700 Subject: [PATCH] Fixed some grammar errors and removed some TODOs --- README.md | 22 +++++++++------------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index ce893df..dabfb55 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # pybadges -pybadges is a Python library and command line tools that allows you to create -Git-hub styles badges as SVG images. For example: +pybadges is a Python library and command line tool that allows you to create +Github-style badges as SVG images. For example: ![pip installation](tests/golden-images/pip.svg) ![pip installation](tests/golden-images/license.svg) ![pip installation](tests/golden-images/build-passing.svg) -The aesthetics of the generated badges matches the visual design of Shields badges +The aesthetics of the generated badges matches the visual design found in this [specification](https://github.com/badges/shields/blob/master/spec/SPECIFICATION.md). The implementation of the library was heavily influenced by @@ -16,10 +16,6 @@ The implementation of the library was heavily influenced by ## Getting Started -These instructions will get you a copy of the project up and running on your -local machine for development and testing purposes. See deployment for notes on -how to deploy the project on a live system. - ### Installing pybadges can be installed using [pip](https://pypi.org/project/pip/): @@ -33,7 +29,7 @@ To test that installation was successful, try: python -m pybadges --left-text=build --right-text=failure --right-color=#c00 --browser ``` -You will see a badge like this in your browser or other image viewer: +You will see a badge like this in your browser: ![pip installation](tests/golden-images/build-failure.svg) @@ -46,8 +42,8 @@ writing Python code. ### Command line usage -Complete documentation of pybadges command arguments can be found using the help -argument: +Complete documentation of pybadges command arguments can be found using the `--help` +flag: ```sh python -m pybadges --help @@ -94,7 +90,7 @@ print(s[:40]) # =>