clean up export, add module level docs

- public NetworkCoordinate so it’s easer to just `use vivaldi_nc::NetworkCoordinate`
- add module level docs and examples in lib.rs
- cleanup README

Signed-off-by: Stephen Waits <steve@waits.net>
This commit is contained in:
swaits committed 2023-02-04 10:39:59 -07:00
1 parent c83a4e654b
commit e9febc6faa
3 files changed
+143 -13

No files matched your search

+3 -3
View File
@@ -65,7 +65,7 @@ impl<const N: usize> NetworkCoordinate<N> {
/// # Example
///
/// ```
/// use vivaldi_nc::network_coordinate::NetworkCoordinate;
/// use vivaldi_nc::NetworkCoordinate;
///
/// // create a new 3-dimensional random NC
/// let a: NetworkCoordinate<3> = NetworkCoordinate::new();
@@ -93,7 +93,7 @@ impl<const N: usize> NetworkCoordinate<N> {
/// # Example
///
/// ```
/// use vivaldi_nc::network_coordinate::NetworkCoordinate;
/// use vivaldi_nc::NetworkCoordinate;
///
/// // create some 2-dimensional NCs for the sake of this example. These will just be random
/// // NCs. In a real usecase these would have meaningful values.
@@ -125,7 +125,7 @@ impl<const N: usize> NetworkCoordinate<N> {
///
/// ```
/// use std::time::Duration;
/// use vivaldi_nc::network_coordinate::NetworkCoordinate;
/// use vivaldi_nc::NetworkCoordinate;
///
/// // We always have our own NC:
/// let mut local: NetworkCoordinate<2> = NetworkCoordinate::new();