Skip to content

Commit 9f80475

Browse files
committed
Update README
1 parent 2db3696 commit 9f80475

File tree

3 files changed

+4
-16
lines changed

3 files changed

+4
-16
lines changed

Cargo.lock

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[package]
2-
version = "0.1.4"
2+
version = "0.1.5"
33

44
name = "libharu_ng"
55
description = "Easily generate PDFs from your Rust app!"

README.md

+2-14
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
![Crates.io Downloads](https://img.shields.io/crates/d/libharu_ng)
55
![GitHub Stars](https://img.shields.io/github/stars/bastibense/libharu_ng)
66

7-
#### ⭐ Support us, be cool, [star this repository on GitHub](https://github.com/bastibense/libharu_ng)! :)
7+
#### ⭐ Support this crate, be cool, [star this repository on GitHub](https://github.com/bastibense/libharu_ng)! :)
88

99
## What is it?
1010

@@ -87,32 +87,20 @@ fn main() -> Result<(), HaruError> {
8787
}
8888
```
8989

90-
# Motivation & Alternatives
90+
# Motivation
9191

9292
The main motivation behind `libharu_ng` is to provide a simple and modern API for generating PDFs from Rust code.
9393

9494
One of the requirements was fine-grained control over the content of the PDF document and minimal dependencies and size/performance overhead.
9595

9696
There are a number of alternatives for generating PDFs from Rust code, each with their own advantages and disadvantages:
9797

98-
- **lopdf** - [Crate](https://crates.io/crates/lopdf) - A pure Rust library for very low-level PDF manipulation.
99-
- **printpdf** - [Crate](https://crates.io/crates/printpdf) - A "higher" level API for generating PDFs, based on `lopdf`.
100-
- **wkhtmltopdf** - [Crate](https://crates.io/crates/wkhtmltopdf) - A wrapper for the `wkhtmltopdf` command line tool - which is deprecated.
101-
- Using a headless browser like Chromium. This will require a _lot_ of RAM - possibly more than your server has available, especially if you want to generate multiple PDFs in parallel.
102-
- ...
103-
104-
This is not a complete list, but it should give you an idea of the alternatives. Of course there are commercial solutions as well, but for many use cases, they are not an option, overkill, require extensive integration or are too expensive.
105-
10698
This crate, as is, will try to compile the `libharu` library from source, embedding it into your Rust project. This means that you don't have to install any additional dependencies on your system, and you don't have to worry about the `libharu` version on your system. If you have problems with the embedded `libharu` version, please open an issue.
10799

108100
# Contributing
109101

110102
Contributions are welcome. Please open an issue before submitting a pull request.
111103

112-
If you want to contribute, please make sure that your code is formatted using `rustfmt` and that it compiles without warnings.
113-
114-
Please refer to the issue tracker for ideas on what to contribute.
115-
116104
# License
117105

118106
- This project is licensed under the MIT license.

0 commit comments

Comments
 (0)