Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MbBrainz authored Jun 5, 2024
1 parent be5e21a commit 61c8946
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
Deciding which workspace information to collect

Collecting workspace information

Filtering to most relevant information

# Bech32 Address Converter

This project provides a library and a command-line interface (CLI) for converting Bech32 addresses with different prefixes. It's written in Rust and is optimized for maximum performance.
Expand All @@ -16,6 +10,19 @@ The project is divided into two main parts:

2. [``bech32-addr-converter-cli``](./bech32-addr-converter-cli): This is a CLI tool that uses the [``bech32-addr-converter``](./bech32-addr-converter) library to convert addresses. The source code is located in [`bech32-addr-converter-cli/src`](./bech32-addr-converter-cli/src).

## Install

install the cli using cargo:

```sh
cargo install bech32-addr-converter-cli
```

or add the converter library to your project
```sh
cargo add bech32-addr-converter
```

## Usage

To use the CLI tool, you need to build the project first. After building, you can run the [``bech32-addr-converter``](./bech32-addr-converter) binary with the appropriate arguments. try `bech32-addr-converter-cli -h` for description.
Expand All @@ -35,4 +42,4 @@ at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in [``bech32-addr-converter``](./bech32-addr-converter)
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in [``bech32-addr-converter``](./bech32-addr-converter)

0 comments on commit 61c8946

Please sign in to comment.