Merge pull request #431 from orottier/feature/readme-and-docs

Unify README.md and crate docs

Author: orottier

README.md

@@ -18,7 +18,7 @@ use it in desktop apps, command line utilities, headless execution, etc.
 
 ## Example usage
 
-```rust
+```rust,no_run
 use web_audio_api::context::{AudioContext, BaseAudioContext};
 use web_audio_api::node::{AudioNode, AudioScheduledSourceNode};
 
@@ -46,7 +46,7 @@ biquad.connect(&context.destination());
 src.start();
 
 // enjoy listening
-loop { }
+std::thread::sleep(std::time::Duration::from_secs(4));
 ```
 
 Check out the [docs](https://docs.rs/web-audio-api) for more info.
@@ -59,7 +59,6 @@ deviations could not be avoided:
 - naming: snake_case instead of CamelCase
 - getters/setters methods instead of exposed attributes
 - introduced some namespacing
-- AudioWorklet functionality is provided in a more rust-friendly way
 - inheritance is modelled with traits
 - ...
 

src/lib.rs

@@ -1,39 +1,4 @@
-//! A high-level API for processing and synthesizing audio.
-//!
-//! # Example
-//! ```no_run
-//! use std::fs::File;
-//! use web_audio_api::context::{BaseAudioContext, AudioContext};
-//! use web_audio_api::node::{AudioNode, AudioScheduledSourceNode};
-//!
-//! // set up AudioContext with optimized settings for your hardware
-//! let context = AudioContext::default();
-//!
-//! // create an audio buffer from a given file
-//! let file = File::open("samples/sample.wav").unwrap();
-//! let buffer = context.decode_audio_data_sync(file).unwrap();
-//!
-//! // play the buffer at given volume
-//! let volume = context.create_gain();
-//! volume.connect(&context.destination());
-//! volume.gain().set_value(0.5);
-//!
-//! let mut buffer_source = context.create_buffer_source();
-//! buffer_source.connect(&volume);
-//! buffer_source.set_buffer(buffer);
-//!
-//! // create oscillator branch
-//! let mut osc = context.create_oscillator();
-//! osc.connect(&context.destination());
-//!
-//! // start the sources
-//! buffer_source.start();
-//! osc.start();
-//!
-//! // enjoy listening
-//! std::thread::sleep(std::time::Duration::from_secs(4));
-//! ```
-
+#![doc = include_str!("../README.md")]
 #![warn(rust_2018_idioms)]
 #![warn(rust_2021_compatibility)]
 #![warn(clippy::missing_panics_doc)]