You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+13-6
Original file line number
Diff line number
Diff line change
@@ -6,21 +6,28 @@ Get things from one computer to another, safely.
6
6
7
7
This is a Rust port of the Python version at <https://github.com/magic-wormhole/magic-wormhole>.
8
8
9
-
## This is a work in progress
9
+
## Comparison with the Python implementation
10
10
11
-
As of version `0.1.0`, most of the major protocols are implemented. The library part can be deemed "usable", although the API is far away from being "stable". There is still a lot of work to be done here, notably error handling and code documentation.
11
+
Features that are missing:
12
12
13
-
The CLI is in a "proof of concept" state at the moment. Basic file sending and receiving is implemented, but everything else is missing. Note that this is not a 1:1 port of the Python CLI; and it won't be a drop-in replacement for it.
13
+
- Tab completion
14
+
- Text message sending
15
+
- Folder sending (we can send folders, but it will send a tar ball which the other side will have to manually unpack)
16
+
- Tor support
17
+
18
+
New features that exceed the other implementations:
19
+
20
+
- Can do direct connections across the internet and firewalls
21
+
- Port forwarding in addition to file transfer (experimental)
22
+
- Send a file to multiple people (experimental)
14
23
15
24
## Getting started
16
25
17
26
If you want to toy with the CLI, `cargo run -- --help` will get you started. The code sits in `./src/bin`.
18
27
19
28
If you'd like to use Wormhole in your application, `cargo doc --open` will tell you how to use it. There aren't any hosted docs at the moment.
20
29
21
-
If you don't fear touching code and want to contribute, `./src/lib.rs`, `./src/transfer.rs` and `./src/transit.rs` are rather easy to get into.
22
-
23
-
However before diving into the `core` module, you should definitively read the [spec](https://magic-wormhole.readthedocs.io/en/latest/) and the [implementation notes](https://github.com/magic-wormhole/magic-wormhole.rs/wiki) first. Maybe having a bit of understanding of the Python implementation doesn't hurt either.
30
+
If you don't fear touching code and want to contribute, `./src/lib.rs`, `./src/transfer.rs` and `./src/transit.rs` are rather easy to get into. The [protocol specification](https://github.com/magic-wormhole/magic-wormhole-protocols) will probably be useful to you.
0 commit comments