Skip to content

Commit 68b6798

Browse files
committed
πŸ“š Add feature list to README.md and docs
1 parent e4cc555 commit 68b6798

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@
44

55
Template for Python packages based on [`copier`](https://copier.readthedocs.io/en/latest/).
66

7+
## Features
8+
9+
* πŸ“¦ **Package management**: Test, build, and deploy your package with [Hatch](https://hatch.pypa.io/) environments.
10+
* πŸ“š **Documentation**: Use [MyST](https://mystmd.org/) or [MkDocs](https://www.mkdocs.org/) to document your package.
11+
* 🧹 **Pre-commit**: Format and lint your code with [Ruff](https://docs.astral.sh/ruff/).
12+
* βš™οΈ **GitHub Actions**:
13+
* Deploy your documentation on [GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site).
14+
715
## Usage
816

917
Follow the [`copier` installation instructions](https://copier.readthedocs.io/en/latest/#installation).

β€Ždocs/index.mdβ€Ž

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
1-
# Getting Started
1+
# Introduction
22

33
A `copier`-based template for Python packages.
44

5+
## Features
6+
7+
* πŸ“¦ **Package management**: Test, build, and deploy your package with [Hatch](https://hatch.pypa.io/) environments.
8+
* πŸ“š **Documentation**: Use [MyST](https://mystmd.org/) or [MkDocs](https://www.mkdocs.org/) to document your package.
9+
* 🧹 **Pre-commit**: Format and lint your code with [Ruff](https://docs.astral.sh/ruff/).
10+
* βš™οΈ **GitHub Actions**:
11+
* Deploy your documentation on [GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site).
12+
513
## Usage
614

715
Follow the [`copier` installation instructions](https://copier.readthedocs.io/en/latest/#installation).

0 commit comments

Comments
Β (0)