From 720e9d68ca61a9ecf64751de9f9a92fc2584b91f Mon Sep 17 00:00:00 2001 From: Matthew Shafer Date: Tue, 2 Feb 2021 16:26:29 -0600 Subject: [PATCH 1/2] change links to fully qualified --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 54998159..f60a8363 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # NI Python Style Guide -![logo](docs/logo.svg) +![logo](https://raw.githubusercontent.com/ni/python-styleguide/main/docs/logo.svg) --- @@ -12,7 +12,7 @@ Welcome to NI's internal and external Python conventions and enforcement tooling Our written conventions can be found at https://ni.github.io/python-styleguide/. -Their source is in [docs/Coding-Conventions.md](docs/Coding-Conventions.md). +Their source is in [docs/Coding-Conventions.md](https://github.com/ni/python-styleguide/tree/main/docs/Coding-Conventions.md). NOTE: Using the GitHub Pages link is preferable to a GitHub `/blob` link. From d3644e2f06b0fb5bdf5a8b703a920466eb8dbc59 Mon Sep 17 00:00:00 2001 From: Matthew Shafer Date: Tue, 2 Feb 2021 16:57:11 -0600 Subject: [PATCH 2/2] add some badges --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f60a8363..a80b4c09 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,8 @@ --- - +[![PyPI version](https://badge.fury.io/py/ni-python-styleguide.svg)](https://badge.fury.io/py/ni-python-styleguide) ![Publish Package](https://github.com/ni/python-styleguide/workflows/Publish%20Package/badge.svg) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) + Welcome to NI's internal and external Python conventions and enforcement tooling.