Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rnbguy committed Mar 10, 2024
1 parent b0a395f commit 231074a
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,29 @@
# rope

![Build Status][build-image]
[![Apache 2.0 Licensed][license-image]][license-link]
![Rust 1.64+][rustc-version]

[build-image]: https://github.com/rnbguy/rope/actions/workflows/cargo.yml/badge.svg
[license-image]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg
[license-link]: https://github.com/rnbguy/rope/blob/main/LICENSE
[rustc-version]: https://img.shields.io/badge/Rustc-Stable%201.74.1+-blue.svg

P2P file transfer utility.

![rope transfer](assets/rope.gif)

This is based on my previous project [figo](https://github.com/rnbguy/figo), but in Rust.
This is based on my previous project [figo](https://github.com/rnbguy/figo), but
in Rust.

# Installation

```
$ cargo install --git https://github.com/rnbguy/rope
```

`rope` uses mDNS to find each other. Before using, make sure both machines are connected to the same network.
`rope` uses mDNS to find each other. Before using, make sure both machines are
connected to the same network.

# Send

Expand Down

0 comments on commit 231074a

Please sign in to comment.