Sfoglia il codice sorgente

serial: Add dev notes on usage and maintenance

parazyd 1 anno fa
parent
commit
dd458b02ca
1 ha cambiato i file con 12 aggiunte e 0 eliminazioni
  1. 12 0
      src/serial/README.md

+ 12 - 0
src/serial/README.md

@@ -0,0 +1,12 @@
+darkfi-serial
+=============
+
+Take note that this crate and its inner crates are published on
+crates.io so when they're used, they should be imported as a regular
+dependency rather than using a local repo path.
+
+When changes are made to the serial library, we should bump its version
+and perform a `cargo publish`.
+
+Eventually we can investigate a path of also exporting `darkfi-serial`
+through `darkfi-sdk` so that dependency management simplifies a bit.