Skip to content

Commit 16f6f22

Browse files
committed
Update README and CHANGELOG
1 parent 848fa2c commit 16f6f22

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
3131
- Change `README.rst` to `README.md`.
3232
- Replace `setup.py` with `pyproject.toml`.
3333
- Renamed `chunks.py` to `raw_io_chunk.py`.
34+
- Changed Sphinx doc to use Markdown with the [Myst parser](https://myst-parser.readthedocs.io/en/latest/).
3435

3536
### Fixed
3637

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ with open("test_file", "rb") as file_handle:
3434

3535
Amazing, right?
3636

37+
## Why?
38+
39+
While writing a parser I found this class to be somewhat useful, around 7 years ago.
40+
41+
While today I don't really see it today, I decided to clean it up and released it in case it's useful for someone.
42+
3743
## Install
3844

3945
Use `pip`:
@@ -44,7 +50,7 @@ $ pip install io-chunks
4450

4551
## Documentation
4652

47-
Use the source, Luke!
53+
You can read it at [readthedocs](https://python-io-chunks.readthedocs.io/en/latest/).
4854

4955
## Run the tests
5056

0 commit comments

Comments
 (0)