Skip to content

Commit 2692dfd

Browse files
committed
doc: make it prettier
1 parent f9405fa commit 2692dfd

File tree

2 files changed

+21
-17
lines changed

2 files changed

+21
-17
lines changed

.gitassets/logo.png

1.75 MB
Loading

README.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,62 @@
1-
# 🌳 AutoPDF
1+
# 📄 AutoPDF
22

3-
**AutoPDF is a tool that helps you create PDF documents from templates.**
3+
<div align="center">
4+
<img src="./.gitassets/logo.png" alt="AutoPDF Logo" width="300" height="300" class="center">
45

5-
Simple. Neat. Fast. Powerful.
6+
[![GoDoc](https://godoc.org/github.com/BuddhiLW/AutoPDF?status.svg)](https://godoc.org/github.com/BuddhiLW/AutoPDF) [![License](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](LICENSE)
67

7-
Perfect for creating professional, customizable PDF documents as a service.
8+
**A tool that creates PDFs, using LaTeX and Go's templating syntax.**
9+
</div>
810

9-
Like, Share, Subscribe, and Hit the Bell Icon!
1011

11-
(Please do mention the software usage in your projects, products, etc.)
1212

13-
[![License](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](LICENSE)
13+
- :zap: Simple. Neat. Fast. Powerful. :zap:
14+
- Perfect for creating professional, customizable PDF documents.
15+
- *Leverages* the most powerful PDF document generator: $\LaTeX$.
1416

15-
Built with ❤️ by [BuddhiLW](https://github.com/BuddhiLW)
16-
Using [Bonzai](https://github.com/rwxrob/bonzai)
17+
> *Like, Share, Subscribe, and Hit the Bell Icon!*
18+
19+
**Please do mention the software usage in your projects, products, etc.**
20+
21+
22+
Built with ❤️ by [BuddhiLW](https://github.com/BuddhiLW). Using [Bonzai](https://github.com/rwxrob/bonzai) 🌳.
1723

1824
## Install
1925

20-
``` bash
26+
```bash
2127
go install github.com/BuddhiLW/AutoPDF/cmd/autopdf@latest
2228
```
2329

2430
## Usage
2531

2632
### Build
2733

28-
``` bash
34+
```bash
2935
cd ./internal/autopdf/test-data
3036

3137
autopdf build template.tex config.yaml # [optional: `clean`]
3238
file out/output.pdf
3339
```
40+
3441
Should output:
3542

3643
```
37-
file out/output.pdf
44+
file out/output.pdf
3845
out/output.pdf: PDF document, version 1.5
3946
```
4047

4148
### Clean up auxiliary files
4249

43-
``` bash
50+
```bash
4451
autopdf clean <path-to-output-directory>
4552
```
4653

4754
Or, more conveniently, you can use the `build` command with the `clean` flag:
4855

49-
``` bash
56+
```bash
5057
autopdf build template.tex config.yaml clean
5158
```
5259

53-
5460
## License
5561

5662
This project is licensed under the [Apache License 2.0](LICENSE).
57-
58-

0 commit comments

Comments
 (0)