update README, bump crate version

Signed-off-by: Stephen Waits <steve@waits.net>
This commit is contained in:
swaits committed 2023-02-04 09:48:01 -07:00
1 parent 2fad2e18b5
commit c83a4e654b
2 files changed
+7 -7

No files matched your search

+1 -1
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "vivaldi-nc" name = "vivaldi-nc"
version = "0.1.0" version = "0.2.0"
edition = "2021" edition = "2021"
authors = ["Stephen Waits <steve@waits.net>"] authors = ["Stephen Waits <steve@waits.net>"]
description = "Vivaldi network coordinates with a simple interface." description = "Vivaldi network coordinates with a simple interface."
+6 -6
View File
@@ -10,11 +10,11 @@ other will be close to each other. Nodes with high latency between them will be
far from each other. far from each other.
This is an implementation of Vivaldi Network Coordinates, a specific NC This is an implementation of Vivaldi Network Coordinates, a specific NC
algorithm, with a simple simple interface and few dependencies. Vivaldi algorithm, with a simple interface and few dependencies. Vivaldi coordinates
coordinates are typically used in distributed networking applications, like p2p are typically used in distributed networking applications, like p2p networks.
networks. They allow each node in the network to estimate its position in a They allow each node in the network to estimate its position in a latency space
latency space in a distributed way, with no central authority. This enables in a distributed way, with no central authority. This enables nodes to
nodes to understand estimated latency to any other node in the system. understand estimated latency to any other node in the system.
According to the [Vivaldi coordinates article on Wikipedia](https://en.wikipedia.org/wiki/Vivaldi_coordinates): According to the [Vivaldi coordinates article on Wikipedia](https://en.wikipedia.org/wiki/Vivaldi_coordinates):
@@ -137,7 +137,7 @@ Several crates implemented Vivaldi NC before this one. So, why another?
I had several design goals which the existing crates didn't satisfy: I had several design goals which the existing crates didn't satisfy:
1. Provide the simplest interface possible. I just want to have some sort of 1. Provide the *simplest interface possible*. I just want to have some sort of
Coordinate struct and be able to update it, and then use it to estimate Coordinate struct and be able to update it, and then use it to estimate
round trip times (ie ping times). round trip times (ie ping times).
2. Don't require the consumer to bring their own vector or linear algebra 2. Don't require the consumer to bring their own vector or linear algebra