Skip to content

Commit 6d94340

Browse files
committed
docs: add README & update cargo file
1 parent acdc33a commit 6d94340

File tree

2 files changed

+61
-0
lines changed

2 files changed

+61
-0
lines changed

Cargo.toml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
11
[package]
22
name = "proxy_logger"
33
version = "0.1.0"
4+
authors = ["Elijah Samson <elijahobara357@gmail.com>"]
5+
description = "Command line interface for proxying TCP connections with payload output into console which can be formatted different ways."
6+
keywords = ["network", "tcp", "proxy", "logging", "debugging"]
7+
categories = [
8+
"command-line-utilities",
9+
"development-tools::debugging",
10+
"network-programming"
11+
]
12+
license = "MIT OR Apache-2.0"
13+
repository = "https://github.com/obaraelijah/proxy_logger"
14+
homepage = "https://github.com/obaraelijah/proxy_logger"
15+
readme = "README.md"
416
edition = "2021"
517

618
[dependencies]

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# proxy_logger
2+
3+
[![Crates.io][crates-badge]][crates-url]
4+
![Rust version][rust-version]
5+
![License][license-badge]
6+
[![Workflow Status][workflow-badge]][actions-url]
7+
8+
[crates-badge]: https://img.shields.io/crates/v/proxy_logger.svg
9+
[crates-url]: https://crates.io/crates/proxy_logger
10+
[license-badge]: https://img.shields.io/crates/l/proxy_logger.svg
11+
[workflow-badge]: https://github.com/qwerty541/logged-tcp-proxy/workflows/check/badge.svg
12+
[actions-url]: https://github.com/qwerty541/logged-tcp-proxy/actions
13+
[rust-version]: https://img.shields.io/badge/rust-1.74.1%2B-lightgrey.svg?logo=rust
14+
15+
## Description
16+
17+
This repository provides a command line interface for proxying TCP connections with payload output into the console. Payload output can be formatted in different ways: hexadecimal (lowercase and uppercase), decimal, octal and binary.
18+
19+
## Installation
20+
21+
### From crates.io (Recommended)
22+
23+
Run the following command and wait until the crate is compiled:
24+
25+
```sh
26+
$ cargo install proxy_logger
27+
```
28+
29+
Now you can run compiled binary:
30+
31+
```sh
32+
$ proxy_logger --bind-listener-addr 127.0.0.1:20502 --remote-addr 127.0.0.1:20582
33+
```
34+
35+
### From git repository
36+
37+
Run the following command and wait until the crate is compiled:
38+
39+
```sh
40+
$ cargo install --git https://github.com/obaraelijah/proxy_logger.git --tag v0.1.0 proxy_logger
41+
```
42+
43+
Also you can remove tag option to install the latest development version.
44+
45+
Now you can run compiled binary:
46+
47+
```sh
48+
$ proxy_logger --bind-listener-addr 127.0.0.1:20502 --remote-addr 127.0.0.1:20582
49+
```

0 commit comments

Comments
 (0)