From 9b91d9962573def6cb16cf193380b0882446f4b4 Mon Sep 17 00:00:00 2001 From: Agustin Borgna Date: Thu, 22 Jun 2023 13:27:41 +0100 Subject: [PATCH 1/2] doc: Crate name as README title --- README.md | 4 ++-- src/lib.rs | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 476bbdd37..27cce789d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -hugr -==== +quantinuum-hugr +=============== [![build_status][]](https://github.com/CQCL/hugr/actions) [![msrv][]](https://github.com/CQCL/hugr) diff --git a/src/lib.rs b/src/lib.rs index 73e441c9f..d62381d45 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -20,6 +20,6 @@ pub mod types; mod utils; pub use crate::hugr::{ - Direction, Hugr, Node, Port, Replace, ReplaceError, SimpleReplacement, Wire, + Direction, Hugr, HugrView, Node, Port, Replace, ReplaceError, SimpleReplacement, Wire, }; pub use crate::resource::Resource; From 32ace5c2cc73361bcc009625a6135dc8100be537 Mon Sep 17 00:00:00 2001 From: Agustin Borgna Date: Thu, 22 Jun 2023 13:32:18 +0100 Subject: [PATCH 2/2] Add usage section for package vs crate name --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 27cce789d..3119cb9ee 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,17 @@ The HUGR specification (still in draft) is [here](specification/hugr.md). - `pyo3`: Enable Python bindings via pyo3. +## Usage + +Add this to your `Cargo.toml`: + +```toml +[dependencies] +quantinuum-hugr = "0.1" +``` + +The library crate is called `hugr`. + ## License This project is licensed under Apache License, Version 2.0 ([LICENSE][] or http://www.apache.org/licenses/LICENSE-2.0).