diff --git a/README.md b/README.md index 9bfe63f1..e1a8ca9e 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,32 @@ -`openlifu` is a toolbox for planning and controlling focused ultrasound -treatments. It generally replicates the functionality developed in the MATLAB -[open-TFUS toolbox](https://github.com/OpenwaterHealth/opw_neuromod_sw). +The `openlifu` repository contains the core Python library for Open-LIFU. + +It provides the software components used to build focused ultrasound research +applications, including treatment planning, simulation, hardware communication, +data models, and supporting utilities. + +If you're looking to develop with the `openlifu` Python package, contribute to +the codebase, or build research workflows using the library, you're in the +right place. + +## What you'll find here + +- The core `openlifu` Python package +- APIs for treatment planning, simulation, and hardware communication +- Developer documentation and examples +- Installation instructions +- Guidance for contributing to the project + +## Learn more + +- 📖 **Quickstart Guide** – +- 📚 **API Documentation** – +- 🌐 **Openwater Community Hub** – +- 🚀 **Good First Issues** – + +--- ## Installation