Skip to content
This repository was archived by the owner on Jan 28, 2026. It is now read-only.

Commit 3e6f28d

Browse files
committed
Add deprecation warning
1 parent f4f2ef0 commit 3e6f28d

File tree

5 files changed

+22
-7
lines changed

5 files changed

+22
-7
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<div class="warning">
2+
The `aquadoggo` crate has been deprecated, please use the new p2panda stack instead.
3+
</div>
4+
15
<h1 align="center">aquadoggo</h1>
26

37
<div align="center">

aquadoggo/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<div class="warning">
2+
The `aquadoggo` crate has been deprecated, please use the new p2panda stack instead.
3+
</div>
4+
15
<h1 align="center">aquadoggo</h1>
26

37
<div align="center">
@@ -48,7 +52,7 @@
4852
`aquadoggo` can run both on your own device for local-first applications, or on a public server when acting as shared community infrastructure. Nodes like `aquadoggo` perform a number of tasks ranging from core p2panda data replication and validation, aiding the discovery and establishment of connections between edge peers, and exposing a developer friendly API used for building applications.
4953

5054
> 📖 Read more about nodes in our [learn](https://aquadoggo.p2panda.org/learn/networks) section<br>
51-
> 🐬 Visit the main repo [README](https://github.com/p2panda/aquadoggo) for more general info
55+
> 🐬 Visit the main repo [README](https://github.com/p2panda/aquadoggo) for more general info
5256
5357
## Features
5458

aquadoggo/src/lib.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// SPDX-License-Identifier: AGPL-3.0-or-later
22

33
#![doc = include_str!("../README.md")]
4+
#![deprecated(note = "This crate has been deprecated, please use the new p2panda stack")]
45
#![warn(
56
missing_debug_implementations,
67
missing_docs,
@@ -11,6 +12,7 @@
1112
unused_import_braces,
1213
unused_qualifications
1314
)]
15+
#![allow(deprecated)]
1416
#![allow(clippy::uninlined_format_args)]
1517
mod api;
1618
mod bus;

aquadoggo_cli/README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
<div class="warning">
2+
The `aquadoggo` crate has been deprecated, please use the new p2panda stack instead.
3+
</div>
4+
15
<h1 align="center">aquadoggo CLI</h1>
26

37
<div align="center">
@@ -172,7 +176,7 @@ blobs_base_path = "$HOME/.local/share/aquadoggo/blobs"
172176

173177
#### Private Network
174178

175-
> "I want only peers who know a pre-shared key to be able to join my network."
179+
> "I want only peers who know a pre-shared key to be able to join my network."
176180
177181
```sh
178182
# Generate a 32 digit hexadecimal string, for example on the command line like this
@@ -234,7 +238,7 @@ Options:
234238
Defaults to 2020
235239
236240
-q, --transport <TRANSPORT>
237-
Protocol (TCP/QUIC) used for node-node communication and data
241+
Protocol (TCP/QUIC) used for node-node communication and data
238242
replication. Defaults to QUIC
239243
240244
-t, --node-port <PORT>
@@ -243,11 +247,11 @@ Options:
243247
244248
-y, --psk <PSK>
245249
Pre-shared key formatted as a 64 digit hexadecimal string.
246-
247-
When provided a private network will be made with only peers knowing
250+
251+
When provided a private network will be made with only peers knowing
248252
the psk being able to form connections.
249-
250-
WARNING: Private networks are only supported when using TCP for the
253+
254+
WARNING: Private networks are only supported when using TCP for the
251255
transport layer.
252256
253257

aquadoggo_cli/src/main.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
// SPDX-License-Identifier: AGPL-3.0-or-later
22

3+
#![allow(deprecated)]
34
mod config;
45
mod key_pair;
56
mod utils;

0 commit comments

Comments
 (0)