Merge pull request #213 from derekpierre/publish-docs-update

Update readme and publishing docs with latest information

Author: derekpierre

PUBLISHING.md

@@ -9,17 +9,46 @@ write your commit messages however you want.
 
 ## Releasing workflow
 
+### Update Version
+
+Update the version in the `Cargo.toml` for the relevant package(s) you want to release.
+
+### Publish Package
+
 We're currently not releasing Python and WASM bindings, we're only releasing the Rust crate.
 
-In order to release a new version, simply run:
+You can either specify all of the packages in the workspace, or just the ones you want to release. The full list is:
+- `ferveo-nucypher-common`
+- `subproductdomain-nucypher`
+- `ferveo-nucypher-tdec`
+- `ferveo-nucypher`
+
+
+In order to release all of the packages, run the following from the `main` branch:
 
 ```bash
-cargo smart-release --update-crates-index
+cargo smart-release \
+  ferveo-nucypher-common \
+  subproductdomain-nucypher \
+  ferveo-nucypher-tdec \
+  ferveo-nucypher \
+  --update-crates-index
 ```
 
+_Typically, `smart-release` handles the package ordering for you, but since the naming of packages don't match their directory names, you
+need to specify the package names explicitly._
+
 Inspect the changes and confirm the release:
 
 ```bash
-cargo smart-release --update-crates-index --execute
+cargo smart-release \
+  ferveo-nucypher-common \
+  subproductdomain-nucypher \
+  ferveo-nucypher-tdec \
+  ferveo-nucypher \
+  --update-crates-index --execute
 ```
 
+- You can modify the command to only publish specific packages if needed.
+- This will update the respective package `CHANGELOG.md` files in one commit, and produce tags for each of the packages. Be
+sure to push up that additional commit and relevant tags to the `main` branch. Using the tags you can create a corresponding GitHub release.

README.md

@@ -2,7 +2,7 @@
 
 ![ci-badge](https://github.com/nucypher/ferveo/actions/workflows/workspace.yml/badge.svg)
 
-_This project is under active development. For questions, please join us at [Threshold Network Discord](https://discord.com/invite/threshold&ved=2ahUKEwivucaW2Y3-AhXiwosKHQCEAKUQFnoECA0QAQ&usg=AOvVaw08x-9JYJFDcd6PEOx0xAeg)_
+_This project is under active development. For questions, please join us at [TACo Discord](https://discord.gg/buildwithtaco)_
 
 ---
 
@@ -32,16 +32,21 @@ A preprint paper describing the construction of Ferveo and the novel cryptosyste
 A Rust toolchain with version `>= 1.87.0` is required. In the future, Ferveo will target the `stable` toolchain.
 Installation via [rustup](https://rustup.rs/) is recommended.
 
-Run `cargo build --release` to build.
+Run `cargo build --no-default-features --release` to build.
 Please note that performance may be significantly poorer when compiling in `Debug` mode.
 
+## Formatting
+
+Be sure to run `cargo fmt --all` locally before committing your changes. This will ensure that the code is formatted
+according to the project's style guidelines.
+
 ## Testing
 
 Run `cargo test --no-default-features --release` to run tests. Please note that performance may be significantly poorer when testing
 in `Debug` mode.
 
 ## Benchmarks
 
-Run `cargo bench --benches` to run benchmarks. Benchmark report is available in the `target/criterion/report` folder.
-
+Run `cargo bench --benches --no-default-features` to run benchmarks. Benchmark report is available in the `target/criterion/report` folder.
 
+**NOTE: Benchmarks are optional (the benchmark CI job is disabled) and take quite some time (~10 mins)**