From cc23a55faacf17b17bd538c96d7206e37aebbb1c Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Fri, 6 Sep 2024 11:19:17 +0900 Subject: [PATCH 1/2] Update README.md to add installation from PyPI --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1f67dc1..808167c 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,10 @@ ## Installation -1. Clone or download this repository. -1. Install the package by running: +[![pypi](https://img.shields.io/pypi/v/sphinx-all-contributors?label=pypi&logo=python&logoColor=white)](https://pypi.org/project/sphinx-all-contributors/) -```bash -pip install . +```shell +pip install sphinx-all-contributors ``` ## Usage From b1bf1758a489aa69715d23d33166814a7deb5035 Mon Sep 17 00:00:00 2001 From: Tetsuo Koyama Date: Fri, 6 Sep 2024 11:20:06 +0900 Subject: [PATCH 2/2] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 808167c..386a2a1 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ `sphinx-all-contributors` is a Sphinx extension that allows you to easily display a list of contributors from a `.all-contributorsrc` file in your Sphinx documentation. The list is generated in a simple, readable format like: ``` -- Contributor Name 1 - ideas, docs -- Contributor Name 2 - code +- Contributor Name 1 for ideas, docs +- Contributor Name 2 for code ``` ## Features