Add notes about available backends

cargodog · Sep 17, 2020 · 9d2b50b · 9d2b50b
1 parent e91c67a
commit 9d2b50b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -28,6 +28,8 @@ criterion = "0.3"
 default = ["std", "serde", "curve25519-dalek/u32_backend"]
 std = []
 simd_backend = ["curve25519-dalek/simd_backend", "blake2/simd_asm"]
+u64_backend = ["curve25519-dalek/u64_backend"]
+u32_backend = ["curve25519-dalek/u32_backend"]
 
 [[bench]]
 name = "prove_and_verify"

diff --git a/README.md b/README.md
@@ -27,10 +27,16 @@ arcturus = "x.y.z"
 ```
 
 By default, `std` and `serde` features are enabled. To build without `std` or without `serde`
-implementations, use the `--no-default-features` option when building. The following example
+implementations, use the `--no-default-features` option when building. Note, if default features
+are disabled, a backend must be specified. The available backends are:
+* `simd_backend`
+* `u64_backend`
+* `u32_backend`
+
+The following example
 builds without `std`, but still implements `serde`:
 ```sh
-cargo build --no-default-features --features "serde"
+cargo build --no-default-features --features "serde simd_backend"
 ```
 
 Please keep the following points in mind when building a project around this library: