Skip to content

Commit

Permalink
Bump version to 0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
piegamesde committed Mar 5, 2022
1 parent db4b00b commit 2234456
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "magic-wormhole"
version = "0.2.0"
version = "0.3.0"
authors = [
"piegames <[email protected]>",
"Brian Warner <[email protected]>"
Expand Down
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,28 @@ Get things from one computer to another, safely.

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

## This is a work in progress
## Comparison with the Python implementation

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.
Features that are missing:

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.
- Tab completion
- Text message sending
- Folder sending (we can send folders, but it will send a tar ball which the other side will have to manually unpack)
- Tor support

New features that exceed the other implementations:

- Can do direct connections across the internet and firewalls
- Port forwarding in addition to file transfer (experimental)
- Send a file to multiple people (experimental)

## Getting started

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

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.

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.

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

## License

Expand Down
5 changes: 5 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,14 @@

## Unreleased

## Version 0.3.0

- Added experimental port forwarding feature
- Improved user experience with better logging and messages
- Improved error and cancellation handling
- Cleaned up CLI args and implemented previous placeholders
- Fixed `send-many` subcommand
- Many internal refactorings to accomodate the changes. The public API did not change that much though.

## Version 0.2.0

Expand Down

0 comments on commit 2234456

Please sign in to comment.