From ae25c9e2611e8edcc26e32d50df83d9a2b5d5dd9 Mon Sep 17 00:00:00 2001 From: d0rianb Date: Sun, 14 Apr 2024 12:02:17 +0200 Subject: [PATCH] Improve README.md spacing --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f2f188..2e2f9f8 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ [![docs.rs](https://img.shields.io/docsrs/rtf-parser?style=flat-square)](https://docs.rs/rtf-parser) A safe Rust RTF parser & lexer library designed for speed and memory efficiency, with no external dependencies. + The official documentation is available at [docs.rs/rtf-parser](https://docs.rs/rtf-parser). ## Installation @@ -51,7 +52,8 @@ The `RtfDocument` struct implement the `TryFrom` trait for : and a `from_filepath` constructor that handle the i/o internally. -The error returned can be a `LexerError` or a `ParserError` depending on the phase wich failed. +The error returned can be a `LexerError` or a `ParserError` depending on the phase wich failed. + An `RtfDocument` is composed with : - the **header**, containing among others the font table, the color table and the encoding. @@ -166,6 +168,7 @@ However, the `rtf-grimoire` crate provide a similar *Lexer*. Here is a quick ben | [`rtf-grimoire`](https://crates.io/crates/rtf-grimoire) (only lexing) | v0.2.1 | _123 ms_ | *This benchmark has been made on an Intel MacBook Pro*. + For the `rtf-parser`, most of the compute time (_65 %_) is spent by the lexing process. There is still lot of room for improvement.