Skip to content

Commit

Permalink
docs: definitely no longer alpha quality
Browse files Browse the repository at this point in the history
Given tokio-vsock has been used in production for a number of years now, it's definitely no longer alpha quality.

Signed-off-by: Damian Peckett <[email protected]>
  • Loading branch information
dpeckett committed May 15, 2024
1 parent 7958ad4 commit a0ca915
Showing 1 changed file with 1 addition and 5 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@
Asynchronous Virtio socket support for Rust. The implementation is
based off of Tokio and Mio's `TCPListener` and `TCPStream` interfaces.

tokio-vsock is for the most part **pre-alpha** quality, so there are probably
**sharp edges**. Please test it thoroughly before using in production. Happy to receive
pull requests and issue reports.

## Use Cases

The most common use case for tokio-vsock would be writing agents for microvm
Expand All @@ -30,7 +26,7 @@ Setup the required Virtio kernel modules:
make kmod
```

Start the test vm, you can shutdown the vm with the keyboard shortcut ```Ctrl+A``` and then ```x```:
Start the test vm, you can shutdown the vm with the keyboard shortcut `Ctrl+A` and then `x`:

```
make vm
Expand Down

0 comments on commit a0ca915

Please sign in to comment.