Add some initial README/docs

Author: faern

README.md

@@ -0,0 +1,12 @@
+## SystemConfiguration bindings
+
+This crate is a high level binding to the Apple [SystemConfiguration] framework. For low level
+FFI bindings, check out the [`system-configuration-sys`] crate.
+
+This crate only implements a small part of the [SystemConfiguration] framework so far. If you
+need a yet unimplemented part, feel free to submit a pull request!
+
+[SystemConfiguration]: https://developer.apple.com/documentation/systemconfiguration?language=objc
+[`system-configuration-sys`]: https://crates.io/crates/system-configuration-sys
+
+License: MIT/Apache-2.0

system-configuration-sys/src/lib.rs

@@ -6,6 +6,12 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+//! Low level bindings to the Apple [SystemConfiguration] framework. Generated with bindgen.
+//! For a safe, higher level, API, check out the [`system-configuration`] crate.
+//!
+//! [SystemConfiguration]: https://developer.apple.com/documentation/systemconfiguration?language=objc
+//! [`system-configuration`]: https://crates.io/crates/system-configuration
+
 #![allow(non_camel_case_types)]
 #![allow(non_upper_case_globals)]
 #![allow(non_snake_case)]

system-configuration/Cargo.toml

@@ -7,6 +7,7 @@ keywords = ["macos", "system", "configuration", "bindings"]
 categories = ["api-bindings", "os::macos-apis"]
 repository = "https://github.com/mullvad/system-configuration-rs"
 license = "MIT/Apache-2.0"
+readme = "../README.md"
 
 [dependencies]
 core-foundation = "0.5"

system-configuration/src/dynamic_store.rs

@@ -6,6 +6,12 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+//! Bindings to [`SCDynamicStore`].
+//!
+//! See the examples directory for examples how to use this module.
+//!
+//! [`SCDynamicStore`]: https://developer.apple.com/documentation/systemconfiguration/scdynamicstore?language=objc
+
 use core_foundation::array::{CFArray, CFArrayRef};
 use core_foundation::base::{TCFType, kCFAllocatorDefault};
 use core_foundation::boolean::CFBoolean;

system-configuration/src/lib.rs

@@ -6,6 +6,17 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
+//! # SystemConfiguration bindings
+//!
+//! This crate is a high level binding to the Apple [SystemConfiguration] framework. For low level
+//! FFI bindings, check out the [`system-configuration-sys`] crate.
+//!
+//! This crate only implements a small part of the [SystemConfiguration] framework so far. If you
+//! need a yet unimplemented part, feel free to submit a pull request!
+//!
+//! [SystemConfiguration]: https://developer.apple.com/documentation/systemconfiguration?language=objc
+//! [`system-configuration-sys`]: https://crates.io/crates/system-configuration-sys
+
 #[macro_use]
 extern crate core_foundation;
 extern crate system_configuration_sys;