PeachCloud
/
go-sbotcli-rs
0
0
Fork 0
Code Issues 3 Pull Requests 1 Projects Releases Wiki Activity

rename crate and change license

This commit is contained in:
glyph 2021-11-05 13:46:35 +02:00
parent e8e31cf9ce
commit 125bf14029
3 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Cargo.toml
View File

@ -1,13 +1,12 @@
[package]
name = "peach-sbotcli"
name = "go-sbotcli-rs"
version = "0.1.0"
authors = ["Andrew Reid <glyph@mycelial.technology>"]
edition = "2018"
description = "A wrapper around the Go sbotcli tool."
homepage = "https://peachcloud.org"
repository = "https://git.coopcloud.tech/PeachCloud/peach-sbotcli"
repository = "https://git.coopcloud.tech/PeachCloud/go-sbotcli-rs"
readme = "README.md"
license = "AGPL-3.0-only"
license = "LGPL-3.0-only"
[dependencies]
dirs = "4.0.0"

8
README.md
View File

@ -1,11 +1,11 @@
# peach-sbotcli
# go-sbotcli-rs
Rust wrapper around the Go `sbotcli` ScuttleButt tool ([cryptoscope/ssb](https://github.com/cryptoscope/ssb)), allowing interaction with a `gosbot` instance.
## Example
```rust
use peach_sbotcli::{Sbot, SbotCliError};
use go_sbotcli_rs::{Sbot, SbotCliError};
fn example() -> Result<(), SbotCliError> {
// uses default paths for `sbotcli` and `go-sbot` working directory
@ -27,11 +27,11 @@ fn example() -> Result<(), SbotCliError> {
Use `cargo doc` to generate and serve the Rust documentation for this library:
```bash
git clone https://git.coopcloud.tech/PeachCloud/peach-sbotcli.git
git clone https://git.coopcloud.tech/PeachCloud/go-sbotcli-rs.git
cd peach-sbotcli
cargo doc --no-deps --open
```
## License
AGPL-3.0
LGPL-3.0

8
src/lib.rs
View File

@ -1,11 +1,11 @@
//! # peach-sbotcli
//! # go-sbotcli-rs
//!
//! Rust wrapper around the Go `sbotcli` ScuttleButt tool ([cryptoscope/ssb](https://github.com/cryptoscope/ssb)), allowing interaction with a `gosbot` instance.
//!
//! ## Example
//!
//! ```rust
//! use peach_sbotcli::{Sbot, SbotCliError};
//! use go_sbotcli_rs::{Sbot, SbotCliError};
//!
//! fn example() -> Result<(), SbotCliError> {
//! // uses default paths for `sbotcli` and `go-sbot` working directory
@ -27,14 +27,14 @@
//! Use `cargo doc` to generate and serve the Rust documentation for this library:
//!
//! ```bash
//! git clone https://git.coopcloud.tech/PeachCloud/peach-sbotcli.git
//! git clone https://git.coopcloud.tech/PeachCloud/go-sbotcli-rs.git
//! cd peach-sbotcli
//! cargo doc --no-deps --open
//! ```
//!
//! ## License
//!
//! AGPL-3.0.
//! LGPL-3.0.
pub mod error;
mod utils;