Skip to content

Commit

Permalink
Tweak README.md and CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
joerivanruth committed Mar 13, 2024
1 parent 61b1852 commit ab17a63
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ What changed in mapiproxy, per version

## mapiproxy NEXTVERSION - YYYY-MM-DD

- Upgrade mio dependency, it had a security issue.
Mapiproxy is not affected but we kept getting warnings.


## mapiproxy 0.6.0 - 2024-02-23

Expand Down
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,13 @@ Pre-built binaries for x86-64 Linux, MacOS, and Windows are available on the
GitHub repository.

Mapiproxy is written in Rust. If you want to build from source and don't have
the Rust compiler installed, you can obtain it from
the Rust compiler installed, visit
[rustup.rs](https://rustup.rs/).

To build from source, simply execute `cargo install mapiproxy` or clone the
repository from GitHub and build using `cargo build --release`.
With Rust installed, simply execute `cargo install mapiproxy`.
This will download the source, compile and install it.
Alternatively, clone the repository from GitHub and build
using `cargo build --release`.


Output Modes
Expand Down Expand Up @@ -101,7 +103,7 @@ binary when at least one of the following conditions holds true:
* binary output is forced using the `-B` or `--binary` flag

When Mapiproxy is in `--messages` mode, it collects all bytes of whole message
and prints them at in a single frame, skipping the block headers. In `--blocks`
and prints them as a single frame, skipping the block headers. In `--blocks`
mode, it collects whole blocks and prints one block per frame, also without the
block header.

Expand Down Expand Up @@ -130,8 +132,8 @@ output. They are marked with angle brackets '⟨' and '⟩'. For example:
Special characters and color escapes
------------------------------------

Mapiproxy output contains some non-ASCII Unicode characters, which currently
cannot be disabled. While this is typically not an issue on Linux and MacOS,
Mapiproxy output contains some non-ASCII Unicode characters. This cannot currently
be disabled. While this is typically not problem on Linux and MacOS,
users on Windows platforms may encounter issues. Please share you experiences.

When writing to a terminal or when explicitly enabled with `--color=always`,
Expand Down

0 comments on commit ab17a63

Please sign in to comment.