Explorar el Código

add instructions for how to import and further detail on project

Chelsea H. Komlo hace 5 años
padre
commit
63c2b071e8
Se han modificado 1 ficheros con 9 adiciones y 0 borrados
  1. 9 0
      README.md

+ 9 - 0
README.md

@@ -25,6 +25,15 @@ transmitted to participants.
 Furthermore, this library does not account for how participants should handle
 the case when a share or update is not valid.
 
+To import this library into an existing Rust project, add the following to the
+dependencies in your project's Cargo.toml
+
+```
+vss = "0.1.0"
+```
+
+This project does not provide an FFI for integration into non-Rust projects.
+
 ## Additional Improvements
 
 Note that although the paper discusses additional improvements to Shamir's