Merge pull request #4 from artichoke/lopopolo/crate-docs

Unify top level docs in README and lib.rs
artichoke · May 12, 2023 · 15f08fc · 15f08fc
2 parents fa01bf0 + 66b3521
commit 15f08fc
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -11,8 +11,8 @@
 Enumeration of the filesystem paths for the various standard system directories
 where apps, resources, etc. get installed.
 
-This crate provides native bindings to `sysdir(3)` library functions on macOS,
-iOS, tvOS, and watchOS.
+This crate exposes Rust bindings to the `sysdir(3)` library functions provided
+by `libSystem.dylib` on macOS, iOS, tvOS, and watchOS.
 
 The `sysdir` API first appeared in OS X 10.12, iOS 10, watchOS 3 and tvOS 10
 replacing the deprecated `NSSystemDirectories(3)` API.

diff --git a/src/lib.rs b/src/lib.rs
@@ -30,7 +30,7 @@
 //! directories where apps, resources, etc. get installed.
 //!
 //! This crate exposes Rust bindings to the `sysdir(3)` library functions
-//! provided by `libSystem.dylib`.
+//! provided by `libSystem.dylib` on macOS, iOS, tvOS, and watchOS.
 //!
 //! For more detailed documentation, refer to the [`sysdir(3)` man page](mod@man).
 //!