feat(README.md): usage of cli tool
This commit is contained in:
2
Doxyfile
2
Doxyfile
@ -48,7 +48,7 @@ PROJECT_NAME = libbasen
|
||||
# could be handy for archiving the generated documentation or if some version
|
||||
# control system is used.
|
||||
|
||||
PROJECT_NUMBER = v1.0.3
|
||||
PROJECT_NUMBER = v1.1.0
|
||||
|
||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||
# for a project that appears at the top of each page and should give viewer a
|
||||
|
||||
14
README.md
14
README.md
@ -13,6 +13,7 @@ c++ encoding/decoding from arbitrary base
|
||||
|
||||
- [Installation](#installation)
|
||||
- [Documentation](#documentation)
|
||||
- [Usage](#usage)
|
||||
- [Contributing](#contributing)
|
||||
|
||||
## Installation
|
||||
@ -35,6 +36,19 @@ sudo make uni USRDIR=(Your installation dir)
|
||||
|
||||
Available [here](https://vsek1ro.github.io/libbasen)
|
||||
|
||||
## Usage
|
||||
|
||||
libbasen package provides `basen` cli tool. Below are examples of use:
|
||||
```
|
||||
echo "hello world" | basen -t hex > encoded.data
|
||||
```
|
||||
```
|
||||
basen -t hex -d < encoded.data > decoded.data
|
||||
```
|
||||
```
|
||||
echo "arbitrary alphabet" | basen -a "0123ABCD"
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Main branch is under protection rules, so you should create pull request. After merging will be runned [authors.sh](https://github.com/vSEK1RO/libbasen/blob/main/authors.sh) for adding all contributors usernames and their number of commits to [AUTHORS](https://github.com/vSEK1RO/libbasen/blob/main/AUTHORS) file.
|
||||
|
||||
Reference in New Issue
Block a user