Skip to content

Commit b5ad79f

Browse files
committed
chore: rename vortex to vortex-protocol
Signed-off-by: Gaius <gaius.qi@gmail.com>
1 parent 9099b6b commit b5ad79f

File tree

7 files changed

+18
-18
lines changed

7 files changed

+18
-18
lines changed

Cargo.lock

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
2-
name = "vortex"
3-
version = "0.1.1"
2+
name = "vortex-protocol"
3+
version = "0.1.0"
44
description = "A P2P file transfer protocol"
55
authors = ["The Dragonfly Developers"]
66
homepage = "https://d7y.io/"

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# Vortex
1+
# Vortex Protocol
22

3-
[![LICENSE](https://img.shields.io/github/license/dragonflyoss/vortex.svg?style=flat-square)](https://github.com/dragonflyoss/vortex/blob/main/LICENSE)
4-
[![Discussions](https://img.shields.io/badge/discussions-on%20github-blue?style=flat-square)](https://github.com/dragonflyoss/vortex/discussions)
3+
[![LICENSE](https://img.shields.io/github/license/dragonflyoss/vortex-protocol.svg?style=flat-square)](https://github.com/dragonflyoss/vortex-protocol/blob/main/LICENSE)
4+
[![Discussions](https://img.shields.io/badge/discussions-on%20github-blue?style=flat-square)](https://github.com/dragonflyoss/vortex-protocol/discussions)
55

66
## Introduction
77

8-
Vortex is a high-performance peer-to-peer (P2P) file transfer protocol implementation in Rust,
8+
Vortex protocol is a high-performance peer-to-peer (P2P) file transfer protocol implementation in Rust,
99
designed as part of the Dragonfly project. It utilizes the TLV (Tag-Length-Value) format for
1010
efficient and flexible data transmission, making it ideal for large-scale file distribution scenarios.
1111

@@ -23,7 +23,7 @@ For details, please see [the specification](docs/README.md).
2323

2424
## Benchmarking
2525

26-
Vortex includes comprehensive benchmarks for packet creation, serialization, and deserialization:
26+
Vortex protocol includes comprehensive benchmarks for packet creation, serialization, and deserialization:
2727

2828
```bash
2929
# Run all benchmarks

benches/vortex.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616

1717
use bytes::Bytes;
1818
use criterion::{black_box, criterion_group, criterion_main, Criterion};
19-
use vortex::tlv::Tag;
20-
use vortex::Vortex;
19+
use vortex_protocol::tlv::Tag;
20+
use vortex_protocol::Vortex;
2121

2222
fn vortex_packet_creation(c: &mut Criterion) {
2323
let mut group = c.benchmark_group("Vortex Packet Creation");

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Vortex
1+
# Vortex Protocol
22

3-
Vortex is a peer-to-peer (P2P) file transfer protocol that utilizes the TLV (Tag-Length-Value) format
3+
Vortex protocol is a peer-to-peer (P2P) file transfer protocol that utilizes the TLV (Tag-Length-Value) format
44
for efficient and flexible data transmission. This protocol is designed to provide reliable and
55
scalable file sharing capabilities.
66

tests/integration_tests.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
use bytes::{BufMut, BytesMut};
22
use std::sync::{Arc, Mutex};
3-
use vortex::error::Error;
4-
use vortex::tlv::Tag;
5-
use vortex::Vortex;
3+
use vortex_protocol::error::Error;
4+
use vortex_protocol::tlv::Tag;
5+
use vortex_protocol::Vortex;
66

77
/// Mock peer for testing.
88
#[derive(Debug, Default)]

tests/prop_tests.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
use bytes::Bytes;
22
use proptest::prelude::*;
33
use proptest::test_runner::TestRunner;
4-
use vortex::tlv::Tag;
5-
use vortex::Vortex;
4+
use vortex_protocol::tlv::Tag;
5+
use vortex_protocol::Vortex;
66

77
/// Generate valid value bytes based on tag.
88
fn generate_value_bytes(tag: Tag) -> Bytes {

0 commit comments

Comments
 (0)