more documentation

msrd0 · Feb 23, 2025 · 577ae7b · 577ae7b
1 parent 43736cb
commit 577ae7b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/rlottie-sys/Cargo.toml b/rlottie-sys/Cargo.toml
@@ -24,10 +24,12 @@ default = ["vendor-samsung"]
 
 # If rlottie cannot be found on the system, download the samsung version of rlottie and
 # compile it. You can force the use of the vendored code by setting `RLOTTIE_NO_PKG_CONFIG`.
+# If both `vendor-samsung` and `vendor-telegram` are enabled, samsung has priority.
 vendor-samsung = ["__vendor"]
 
 # If rlottie cannot be found on the system, download the telegram version of rlottie and
 # compile it. You can force the use of the vendored code by setting `RLOTTIE_NO_PKG_CONFIG`.
+# If both `vendor-samsung` and `vendor-telegram` are enabled, samsung has priority.
 vendor-telegram = ["__vendor"]
 
 # Internal

diff --git a/rlottie-sys/README.md b/rlottie-sys/README.md
@@ -1,3 +1,11 @@
 # rlottie-sys [![rlottie-sys on crates.io](https://img.shields.io/crates/v/rlottie-sys.svg)](https://crates.io/crates/rlottie-sys) [![rlottie-sys docs](https://img.shields.io/badge/docs-release-blue)](https://docs.msrd0.de/#rlottie-sys) [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://mit-license.org/)
 
 Rust bindings to rlottie.
+
+## Features
+
+ - `vendor-samsung` (enabled by default): If rlottie cannot be found on the system download the samsung version of rlottie and compile it. You can force the use of the vendored code by setting `RLOTTIE_NO_PKG_CONFIG`.
+
+ - `vendor-telegram`: If rlottie cannot be found on the system download the telegram version of rlottie and compile it. You can force the use of the vendored code by setting `RLOTTIE_NO_PKG_CONFIG`.
+
+If both `vendor-samsung` and `vendor-telegram` are enabled, samsung has priority.