Auto merge of #244 - troy/aac-docs, r=lennartkloock

adds a readme and licenese for the aac crate
setup the create to be ready to publish

Requested-by: TroyKomodo <[email protected]>
Reviewed-by: lennartkloock <[email protected]>

crates/aac/Cargo.toml

@@ -3,6 +3,12 @@ name = "scuffle-aac"
 version = "0.0.1"
 edition = "2021"
 license = "MIT OR Apache-2.0"
+description = "A crate for decoding AAC audio headers."
+repository = "https://github.com/scufflecloud/scuffle"
+authors = ["Scuffle <[email protected]>"]
+readme = "README.md"
+documentation = "https://docs.rs/scuffle-aac"
+keywords = ["aac", "audio", "codec"]
 
 [lints.rust]
 unexpected_cfgs = { level = "warn", check-cfg = ['cfg(coverage_nightly)'] }

crates/aac/LICENSE.Apache-2.0

@@ -0,0 +1 @@
+../../LICENSE.Apache-2.0

crates/aac/LICENSE.MIT

@@ -0,0 +1 @@
+../../LICENSE.MIT

crates/aac/README.md

@@ -0,0 +1,17 @@
+# scuffle-aac
+
+> [!WARNING]  
+> This crate is under active development and may not be stable.
+
+[![crates.io](https://img.shields.io/crates/v/scuffle-aac.svg)](https://crates.io/crates/scuffle-aac) [![docs.rs](https://img.shields.io/docsrs/scuffle-aac)](https://docs.rs/scuffle-aac)
+
+---
+
+A crate for decoding AAC audio headers.
+
+## License
+
+This project is licensed under the [MIT](./LICENSE.MIT) or [Apache-2.0](./LICENSE.Apache-2.0) license.
+You can choose between one of them if you use this work.
+
+`SPDX-License-Identifier: MIT OR Apache-2.0`

crates/aac/src/lib.rs

@@ -1,3 +1,14 @@
+//! # scuffle-aac
+//!
+//! A crate for decoding AAC audio headers.
+//!
+//! ## License
+//!
+//! This project is licensed under the [MIT](./LICENSE.MIT) or
+//! [Apache-2.0](./LICENSE.Apache-2.0) license. You can choose between one of
+//! them if you use this work.
+//!
+//! `SPDX-License-Identifier: MIT OR Apache-2.0`
 #![cfg_attr(all(coverage_nightly, test), feature(coverage_attribute))]
 
 use std::io;