cli/README.md

51 lines
1.4 KiB
Markdown

<div align="center">
<h1>mCaptcha PoW CLI</h1>
<p>
<strong>mCaptcha - PoW based DoS protection</strong>
</p>
[![Documentation](https://img.shields.io/badge/docs-master-blue)](https://mcaptcha.github.io/mCaptcha/mcaptcha_cli/index.html)
![CI (Linux)](<https://github.com/mCaptcha/cli/workflows/CI%20(Linux)/badge.svg>)
[![dependency status](https://deps.rs/repo/github/mCaptcha/cli/status.svg)](https://deps.rs/repo/github/mCaptcha/cli)
<br />
[![codecov](https://codecov.io/gh/mCaptcha/cli/branch/master/graph/badge.svg)](https://codecov.io/gh/mCaptcha/cli)
</div>
## Usage
```bash
mCaptcha PoW CLI 0.1.0
Aravinth Manivannan <realaravinth@batsense.net>
Generates PoW for mCaptcha
USAGE:
mcaptcha-cli [OPTIONS]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-d, --difficulty <INTEGER> Difficulty factor
-p, --phrase <STRING> Phrase over which PoW should be computed
-s, --salt <STRING> Salt with which PoW should be computed
```
## Funding
### NLnet
<div align="center">
<img
height="150px"
alt="NLnet NGIZero logo"
src="./docs/third-party/NGIZero-green.hex.svg"
/>
</div>
<br />
2023 development is funded through the [NGI0 Entrust
Fund](https://nlnet.nl/entrust), via [NLnet](https://nlnet.nl/). Please
see [here](https://nlnet.nl/project/mCaptcha/) for more details.