Skip to content

Commit 3da9360

Browse files
committed
update documentation
1 parent ab4f6e3 commit 3da9360

4 files changed

Lines changed: 10 additions & 13 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,5 @@ members of the project's leadership.
6767

6868
## Attribution
6969

70-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 3.0,
71-
available at [https://www.contributor-covenant.org/version/3/0/code_of_conduct/][version]
72-
73-
[homepage]: https://contributor-covenant.org
74-
[version]: https://www.contributor-covenant.org/version/3/0/
70+
This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org), version 3.0,
71+
available at [https://www.contributor-covenant.org/version/3/0/code_of_conduct/](https://www.contributor-covenant.org/version/3/0/)

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
When contributing to this repository, please first discuss the change you wish to make via issue,
44
email, or any other method with the owners of this repository before making a change.
55

6-
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
6+
Please note we have a [code of conduct](https://github.com/jonathandung/asyncutils/blob/main/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
77

88
## Pull Request Process
99

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,6 @@ Have fun!
115115
![PyPI - Wheel](https://img.shields.io/pypi/wheel/py-asyncutils)
116116
![PyPI - Format](https://img.shields.io/pypi/format/py-asyncutils)
117117
![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)
118-
![Tests](badges/tests.svg)
119-
![Coverage](badges/coverage.svg)
118+
![Tests](https://github.com/jonathandung/asyncutils/blob/main/badges/tests.svg)
119+
![Coverage](https://github.com/jonathandung/asyncutils/blob/main/badges/coverage.svg)
120120
![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)

SUPPORT.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Thank you for using asyncutils! This document outlines how to get help with this project.
44

5-
Before jumping to seek support, please check **[README.md](README.md)** for basic usage and installation.
5+
Before jumping to seek support, please check **[README.md](https://github.com/jonathandung/asyncutils/blob/main/README.md)** for a basic usage and installation guide.
66

77
## Bug Reports
88

@@ -15,7 +15,7 @@ If you've found a bug, please:
1515
- Python version (`python --version`)
1616
- asyncutils version (`autils -v`)
1717
- Operating system
18-
- Package version (`pip show [package-name]` or `conda list [package-name]`)
18+
- Package version (`pip show py-asyncutils` or `conda list py-asyncutils`)
1919
- Minimal reproducible example
2020
- Full error traceback
2121

@@ -60,7 +60,7 @@ python -m pip install --upgrade pip
6060
pip uninstall py-asyncutils
6161
pip install py-asyncutils
6262

63-
# If using conda (not yet supported; will be added in the future)
63+
# If using conda
6464
conda update py-asyncutils
6565
```
6666

@@ -71,14 +71,14 @@ conda update py-asyncutils
7171
pip list | grep py-asyncutils
7272
# Check sys.path
7373
python -c "print(*__import__('sys').path, sep='\n')"
74-
# Check for package naming conflicts; following snippet should print altlocks, base, buckets, caches, channels, cli, compete, ... separated by newlines
74+
# Check for package naming conflicts; following snippet should print altlocks, base, buckets, caches, channels, cli, compete, config, console, constants, # context, ... separated by newlines
7575
python -c "print(*dir(__import__('asyncutils')), sep='\n')"
7676
```
7777

7878
## Version Compatibility
7979

8080
- Python 3.14+ required
81-
- No dependencies, which we're proud of
81+
- No dependencies outside development, which we're proud of
8282
- Maybe use virtual environments
8383

8484
## Response Times

0 commit comments

Comments
 (0)