Skip to content

Commit 6796d93

Browse files
authored
Update README (#2)
1 parent b9ea794 commit 6796d93

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# sphinxext-rediraffe
2+
![ci](https://github.com/wpilibsuite/sphinxext-rediraffe/workflows/ci/badge.svg)
23
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
34

45
Sphinx Extension to redirect files
@@ -10,11 +11,11 @@ Additionally, a builder is provided to check that deleted/renamed files in your
1011

1112
Rediraffe supports the html and dirhtml builders.
1213

13-
Note: Chained redirects will be resolved. For example, if a config has 6 chained redirects, all 6 links will redirect directly to the final link. The enduser will never experience more than 1 redirection.
14+
Note: Chained redirects will be resolved. For example, if a config has 6 chained redirects, all 6 links will redirect directly to the final link. The end user will never experience more than 1 redirection.
1415

1516
## Installation
1617

17-
`python -m pip install git+https://github.com/wpilibsuite/sphinxext-rediraffe.git`
18+
`python -m pip install sphinxext-rediraffe`
1819

1920

2021
## Usage

0 commit comments

Comments
 (0)