Skip to content

Commit 2234456

Browse files
committed
Bump version to 0.3.0
1 parent db4b00b commit 2234456

File tree

3 files changed

+19
-7
lines changed

3 files changed

+19
-7
lines changed

Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "magic-wormhole"
3-
version = "0.2.0"
3+
version = "0.3.0"
44
authors = [
55
"piegames <[email protected]>",
66
"Brian Warner <[email protected]>"

README.md

+13-6
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,28 @@ Get things from one computer to another, safely.
66

77
This is a Rust port of the Python version at <https://github.com/magic-wormhole/magic-wormhole>.
88

9-
## This is a work in progress
9+
## Comparison with the Python implementation
1010

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:
1212

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)
1423

1524
## Getting started
1625

1726
If you want to toy with the CLI, `cargo run -- --help` will get you started. The code sits in `./src/bin`.
1827

1928
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.
2029

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.
2431

2532
## License
2633

changelog.md

+5
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@
22

33
## Unreleased
44

5+
## Version 0.3.0
6+
7+
- Added experimental port forwarding feature
58
- Improved user experience with better logging and messages
9+
- Improved error and cancellation handling
610
- Cleaned up CLI args and implemented previous placeholders
711
- Fixed `send-many` subcommand
12+
- Many internal refactorings to accomodate the changes. The public API did not change that much though.
813

914
## Version 0.2.0
1015

0 commit comments

Comments
 (0)