Skip to content

Commit 8a22464

Browse files
committed
docs: Improve README
- add what you get from using SVG+YAML - add how quickly you can get started - Move "Documentation" to be before "Examples"
1 parent 2c390da commit 8a22464

1 file changed

Lines changed: 19 additions & 14 deletions

File tree

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@
1414

1515
Create PDF documents from YAML-configured SVG templates.
1616

17+
- **Separation of design and content:** Design your layout visually in SVG, while
18+
managing content and configuration in YAML.
19+
- **Instant templating:** Turn any existing SVG into a configurable template with a
20+
single command.
21+
1722
## Installation
1823

1924
pdfbaker is available on [PyPI](https://pypi.org/project/pdfbaker/) and can be installed
@@ -41,7 +46,7 @@ If you are using Windows, GTK needs to be installed:
4146
- Choose your installation location
4247
- Complete the installation
4348

44-
## Optional Dependencies
49+
### Optional Dependencies
4550

4651
- For SVG to PDF conversion, [CairoSVG](https://cairosvg.org/) is used by default. If
4752
you need [Inkscape](https://inkscape.org/) instead, install it:
@@ -101,6 +106,19 @@ The fastest way to get started is with the `--create-from` option:
101106

102107
to regenerate your PDFs.
103108

109+
## Documentation
110+
111+
- [Overview](https://github.com/pythonnz/pdfbaker/blob/main/docs/overview.md) - Start
112+
here
113+
- [Usage](https://github.com/pythonnz/pdfbaker/blob/main/docs/usage.md) - From the CLI
114+
or as a library
115+
- [Configuration Reference](https://github.com/pythonnz/pdfbaker/blob/main/docs/configuration.md) -
116+
All available settings
117+
- [Document Variants](https://github.com/pythonnz/pdfbaker/blob/main/docs/variants.md) -
118+
Create multiple versions of the same document
119+
- [Custom Processing](https://github.com/pythonnz/pdfbaker/blob/main/docs/custom_processing.md) -
120+
Provide page content from anywhere
121+
104122
## Examples
105123

106124
For working examples, see the
@@ -123,19 +141,6 @@ Create all PDFs with:
123141
pdfbaker examples/examples.yaml
124142
```
125143

126-
## Documentation
127-
128-
- [Overview](https://github.com/pythonnz/pdfbaker/blob/main/docs/overview.md) - Start
129-
here
130-
- [Usage](https://github.com/pythonnz/pdfbaker/blob/main/docs/usage.md) - From the CLI
131-
or as a library
132-
- [Configuration Reference](https://github.com/pythonnz/pdfbaker/blob/main/docs/configuration.md) -
133-
All available settings
134-
- [Document Variants](https://github.com/pythonnz/pdfbaker/blob/main/docs/variants.md) -
135-
Create multiple versions of the same document
136-
- [Custom Processing](https://github.com/pythonnz/pdfbaker/blob/main/docs/custom_processing.md) -
137-
Provide page content from anywhere
138-
139144
## Development
140145

141146
All source code is [on GitHub](https://github.com/pythonnz/pdfbaker).

0 commit comments

Comments
 (0)