From 8140832edf39266b6dee4a8723e8ff4e0a850fc0 Mon Sep 17 00:00:00 2001 From: Leedehai <18319900+Leedehai@users.noreply.github.com> Date: Wed, 13 Dec 2023 03:34:41 -0500 Subject: [PATCH] Improve project's description. --- Cargo.toml | 2 +- README.md | 12 +++++------- src/lib.rs | 9 ++++----- 3 files changed, 10 insertions(+), 13 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 0a2eb0ed..424caf0e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,7 +5,7 @@ authors = ["Yevhenii Reizner "] keywords = ["ttf", "truetype", "opentype"] categories = ["parser-implementations"] license = "MIT OR Apache-2.0" -description = "A high-level, safe, zero-allocation TrueType font parser." +description = "A high-level, safe, zero-allocation font parser for TrueType, OpenType, and AAT." repository = "https://github.com/RazrFalcon/ttf-parser" documentation = "https://docs.rs/ttf-parser/" readme = "README.md" diff --git a/README.md b/README.md index 4918b34c..096860c9 100644 --- a/README.md +++ b/README.md @@ -5,14 +5,12 @@ [![Rust 1.42+](https://img.shields.io/badge/rust-1.42+-orange.svg)](https://www.rust-lang.org) ![](https://img.shields.io/badge/unsafe-forbidden-brightgreen.svg) -A high-level, safe, zero-allocation TrueType font parser. +A high-level, safe, zero-allocation font parser for +[TrueType](https://docs.microsoft.com/en-us/typography/truetype/), +[OpenType](https://docs.microsoft.com/en-us/typography/opentype/spec/), and +[AAT](https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6AATIntro.html). -Supports [TrueType](https://docs.microsoft.com/en-us/typography/truetype/), -[OpenType](https://docs.microsoft.com/en-us/typography/opentype/spec/) -and [AAT](https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6AATIntro.html) -fonts. - -Can be used as Rust and as C library. +Can be used as a Rust or C library. ### Features diff --git a/src/lib.rs b/src/lib.rs index 939e0199..64d866a5 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,9 +1,8 @@ /*! -A high-level, safe, zero-allocation TrueType font parser. - -Supports [TrueType](https://docs.microsoft.com/en-us/typography/truetype/), -[OpenType](https://docs.microsoft.com/en-us/typography/opentype/spec/) -and [AAT](https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6AATIntro.html) +A high-level, safe, zero-allocation font parser for: +* [TrueType](https://docs.microsoft.com/en-us/typography/truetype/), +* [OpenType](https://docs.microsoft.com/en-us/typography/opentype/spec/), and +* [AAT](https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6AATIntro.html) fonts. Font parsing starts with a [`Face`].