Skip to content

Commit 68a5e47

Browse files
authored
Bump before release 0.1.4 (#51)
* Update pyproject.toml * Update CHANGELOG.md * add documentation * Update README.md
1 parent 7be8f8c commit 68a5e47

File tree

3 files changed

+11
-6
lines changed

3 files changed

+11
-6
lines changed

CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ All notable changes to this project will be documented in this file.
1212

1313
### Other Changes
1414

15-
## [v0.1.4] 5 May 2024
16-
- Improve Dev Experience.
17-
- Better Typing.
15+
## [v0.1.4] 6 May 2024
16+
- Improve Dev Experience. https://github.com/john0isaac/markdown-checker/pull/28
17+
- Better Typing. https://github.com/john0isaac/markdown-checker/pull/37
1818
- Add ruff, black, mypy and workflows to check them on all supported python versions.
1919
- Add pre-commit.
2020
- Change packaging strategy to setuptools with pyproject.toml.
21-
- Add docs
21+
- Add docs in read the docs https://markdown-checker.readthedocs.io/en/latest/
2222

2323
## [v0.1.3] 15 March 2024
2424
* Change lessons to files

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[![PyPi](https://img.shields.io/pypi/v/markdown-checker)](https://pypi.org/project/markdown-checker/)
2+
[![Documentation Status](https://readthedocs.org/projects/markdown-checker/badge/?version=latest)](https://markdown-checker.readthedocs.io/en/latest/?badge=latest)
23
[![Downloads](https://img.shields.io/pypi/dm/markdown-checker)](https://pypi.org/project/markdown-checker/)
34

45
[![GitHub issues](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/john0isaac/markdown-checker/issues)
@@ -14,6 +15,10 @@ Install the package:
1415
pip install markdown-checker
1516
```
1617

18+
### Documentation
19+
20+
- [Full documentation](https://markdown-checker.readthedocs.io/en/latest/).
21+
1722
## 1, 2, 3 - How To
1823

1924
1. Run `pip install markdown-checker`.

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
55
[project]
66
name = "markdown-checker"
77
description= "A markdown link validation reporting tool"
8-
version = "0.1.3"
8+
version = "0.1.4"
99
authors = [{ name = "John Aziz", email = "[email protected]" }]
1010
maintainers = [{ name = "John Aziz", email = "[email protected]" }]
1111
license = {file = "LICENSE"}
@@ -30,7 +30,7 @@ classifiers = [
3030

3131
[project.urls]
3232
Homepage = "https://github.com/john0isaac/markdown-checker"
33-
Repository = "https://github.com/john0isaac/markdown-checker.git"
33+
Documentation = "https://markdown-checker.readthedocs.io/en/latest/"
3434
Issues = "https://github.com/john0isaac/markdown-checker/issues"
3535
Contributing = "https://github.com/john0isaac/markdown-checker/pulls"
3636
Releases = "https://github.com/john0isaac/markdown-checker/releases"

0 commit comments

Comments
 (0)