docs: improve README and fix Cargo.toml keywords

Cargo.toml

@@ -7,7 +7,7 @@ license = "MIT OR Apache-2.0"
 description = "A Hardware Abstraction Layer for the MAX7800X microcontroller family"
 repository = "https://github.com/sigpwny/max7800x-hal"
 readme = "README.md"
-keywords = ["max78000", "max78002", "max7800x", "embedded-hal", "hal", "arm", "cortex-m"]
+keywords = ["max78000", "embedded-hal", "arm", "cortex-m"]
 categories = ["embedded", "hardware-support", "no-std", "no-std::no-alloc"]
 
 [package.metadata.docs.rs]

README.md

@@ -1,34 +1,45 @@
 # max7800x-hal
-This is a Hardware Abstraction Layer (HAL) for the MAX78000 microcontroller. The HAL is built on top of a Peripheral Access Crate (PAC), [`max78000-pac`](https://github.com/sigpwny/max78000-pac), which provides low-level access to the MAX78000's registers. The HAL provides a higher-level interface to the MAX78000's peripherals, making it easier to write applications.
+[![Crates.io Version](https://img.shields.io/crates/v/max7800x-hal)](https://crates.io/crates/max7800x-hal)
+[![docs.rs](https://img.shields.io/docsrs/max78000-hal)](https://docs.rs/max7800x-hal)
 
-A Board Support Package (BSP) for the MAX78000FTHR is also being developed alongside this HAL. More details will be released soon.
+This is an [Embedded HAL] (Hardware Abstraction Layer) for the MAX78000 microcontroller from Analog Devices.
+
+The HAL is built on top of the [`max78000-pac`] Peripheral Access Crate, which provides low-level access to the MAX78000's registers. The HAL provides a higher-level interface to the MAX78000's peripherals, making it easier to write applications.
+
+[Embedded HAL]: https://crates.io/crates/embedded-hal
+[`max78000-pac`]: https://github.com/sigpwny/max78000-pac
 
 ## Roadmap
-See the [roadmap](https://github.com/sigpwny/max7800x-hal/issues/1) to see current progress and future plans.
+See the [roadmap] to see current implementation progress and future plans.
+
+[roadmap]: https://github.com/sigpwny/max7800x-hal/issues/1
 
 > [!NOTE]  
-> This HAL is under active development. As a result, the API is volatile and subject to change. Be sure to refer to the [changelog](https://github.com/sigpwny/max7800x-hal/releases) for breaking changes.
+> This HAL is under active development. As a result, the API is volatile and subject to change. Be sure to refer to the [changelog] for breaking changes.
 
-## Getting Started
-Coming Soon™️
+If you want updates for when new releases are made, you can watch this repository by clicking the "Watch" button at the top of the page.
 
-### Installing Rust
-Coming Soon™️
+[changelog]: https://github.com/sigpwny/max7800x-hal/releases
 
-### Flashing
-Coming Soon™️, but the gist is that it's currently done via Analog Device's custom OpenOCD fork and `arm-none-eabi-gdb`. This is more relevant to the BSP, but it's worth mentioning here.
+## Getting Started
+If you already have an existing Rust project, you can add this crate by running:
+```sh
+cargo add --features "rt" max7800x-hal
+```
 
-### Debugging
-Coming Soon™️
+Otherwise, we recommend getting started using this [Crate template for the MAX78000FTHR board](https://github.com/sigpwny/max78000fthr-template). If you are not using the MAX78000FTHR board, you can still use the template as a reference for setting up your own project.
 
-## Documentation
-Documentation for this HAL can be obtained by building the docs with `cargo`:
+```sh
+cargo generate --git https://github.com/sigpwny/max78000fthr-template
+```
 
+## Documentation
+Documentation for this HAL can be built by running:
 ```sh
 cargo doc --open
 ```
 
-Documentation will also eventually be on `docs.rs` once the crate is published.
+Documentation can also be found on [docs.rs](https://docs.rs/max7800x-hal).
 
 ## Contributing
 We welcome contributions from the community! If you want to contribute to this project, follow the steps below to get started:
@@ -39,15 +50,21 @@ We welcome contributions from the community! If you want to contribute to this p
 5. Get merged!
 
 ## Maintainers
-- SIGPwny
+- [SIGPwny](https://sigpwny.com) of the University of Illinois Urbana-Champaign
 
 We are happy to invite additional maintainers to this repository, especially those who are involved in the eCTF competition! You can contact us at `[email protected]` or via [Discord](https://sigpwny.com/discord) to request becoming a maintainer.
 
 ## License
-The contents of this repository are dual-licensed under the *MIT OR Apache 2.0* License. This means you may choose either the MIT license or the Apache-2.0 license when using this code. See [`LICENSE-MIT`](./LICENSE-MIT) or [`LICENSE-APACHE`](./LICENSE-APACHE) for each of these licenses.
+This template is licensed under either of:
+
+- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
+  http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
 
-Unless you explicitly state otherwise, any contribution you intentionally submit
-for inclusion in this repository, as defined in the Apache-2.0 license, shall be
-dual-licensed as stated above without any additional terms or conditions.
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions.
 
 Copyright (c) 2025 SIGPwny