Skip to content

Commit bd75743

Browse files
authored
docs(readme): update key features section (#91)
1 parent ebfcd83 commit bd75743

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,13 @@ The Python Starter is a [GitHub repository template](https://docs.github.com/en/
1010

1111
## Key Features
1212

13-
- [Poetry](https://python-poetry.org/) for project management.
14-
- [Pytest](https://docs.pytest.org/en/7.4.x/) for testing and coverage checks.
15-
- Documentation generation with [pydoctor](https://pydoctor.readthedocs.io/en/latest/index.html).
16-
- Consistent code formatting with [Black](https://black.readthedocs.io/en/stable/).
17-
- Import sorting with [isort](https://pycqa.github.io/isort/).
18-
- Static analysis and linting with [Flake8](https://flake8.pycqa.org/en/latest/).
19-
- Preconfigured [GitHub Actions](https://github.com/features/actions) workflow for CI.
20-
- Documentation deployment on [GitHub Pages](https://pages.github.com/).
21-
- [Dependabot](https://docs.github.com/en/code-security/dependabot) support for dependency updates.
13+
- Organized file structure for Python projects, featuring a sample `pyproject.toml`, a sample module, and associated testing files.
14+
- Project and dependency management with [Poetry](https://python-poetry.org/), supplemented by [Poe the Poet](https://poethepoet.natn.io/index.html) for task management.
15+
- Code formatting and linting with [Ruff](https://github.com/astral-sh/ruff), leveraging all recommended rules for enhanced code quality.
16+
- Testing framework powered by [Pytest](https://docs.pytest.org/en/7.4.x/), complete with support for test coverage checks.
17+
- API documentation generation with [pydoctor](https://pydoctor.readthedocs.io/en/latest/index.html) and automated deployment to [GitHub Pages](https://pages.github.com/).
18+
- [GitHub Actions](https://github.com/features/actions) support with multiple workflows for continuous integration (CI) and continuous delivery (CD).
19+
- Automated dependency update checks with [Dependabot](https://docs.github.com/en/code-security/dependabot).
2220

2321
## Usage
2422

0 commit comments

Comments
 (0)