Skip to content

Commit fe637bb

Browse files
authored
Small documentation updates (#136)
1 parent 5f14f26 commit fe637bb

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ A friendly rust interface for [Apple's Core Audio API](https://developer.apple.c
44

55
This crate aims to expose and wrap the functionality of the original C API in a zero-cost, safe, Rust-esque manner.
66

7-
If you just want direct access to the unsafe bindings, use [coreaudio-sys](https://crates.io/crates/coreaudio-sys).
7+
If you just want direct access to the Core Audio APIs,
8+
use the appropriate crates of the [objc2 project](https://crates.io/crates/objc2).

src/lib.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55
//!
66
//! Read the CoreAudio Overview [here](https://developer.apple.com/library/mac/documentation/MusicAudio/Conceptual/CoreAudioOverview/Introduction/Introduction.html).
77
//!
8-
//! Currently, work has only been started on the [audio_unit](./audio_unit/index.html) module, but
9-
//! eventually we'd like to cover at least the majority of the C API.
8+
//! Currently, this crate provides the [audio_unit] module that covers the
9+
//! [Audio Unit framework](https://developer.apple.com/documentation/audiounit)
10+
//! (now part of [Audio Toolbox](https://developer.apple.com/documentation/AudioToolbox)).
1011
1112
#[macro_use]
1213
extern crate bitflags;

0 commit comments

Comments
 (0)