chore: add README.md [skip ci]

This commit is contained in:
Dawid Wysokiński 2024-04-30 09:36:12 +02:00
parent 6dbb18b543
commit 1f0e51e532
Signed by: Kichiyaki
GPG Key ID: B5445E357FB8B892
2 changed files with 43 additions and 0 deletions

43
README.md Normal file
View File

@ -0,0 +1,43 @@
<h1 align="center">CLI to generate <a href="https://en.wikipedia.org/wiki/One-time_password">OTPs</a> from <a href="https://getaegis.app/">Aegis</a> <a href="https://github.com/beemdevelopment/Aegis/blob/master/docs/vault.md">vault file</a></h1>
<div align="center">
[![Release](https://img.shields.io/gitea/v/release/Kichiyaki/goaegis?gitea_url=https%3A%2F%2Fgitea.dwysokinski.me)](https://gitea.dwysokinski.me/Kichiyaki/goaegis/releases)
[![License](https://img.shields.io/badge/License-MIT-green)](#license)
[![Go Report Card](https://goreportcard.com/badge/gitea.dwysokinski.me/Kichiyaki/goaegis)](https://goreportcard.com/report/gitea.dwysokinski.me/Kichiyaki/goaegis)
[![CI/CD](https://woodpecker.dwysokinski.me/api/badges/19/status.svg)](https://woodpecker.dwysokinski.me/repos/19)
</div>
<p align="center">
<a href="mailto:contact@dwysokinski.me">Report Bug</a>
·
<a href="mailto:contact@dwysokinski.me">Request Feature</a>
</p>
![list.png](assets/images/list.png)
## Installation
### Linux/Windows
You can download prebuild binaries from [this page](https://gitea.dwysokinski.me/Kichiyaki/goaegis/releases).
### go install
You can also install this CLI via go install. Go **1.22+** is required to do so.
```shell
go install gitea.dwysokinski.me/Kichiyaki/goaegis/cmd/goaegis@latest
```
### Shell Completion
#### bash
Add the following to the end of ``~/.bashrc``:
```shell
source <(goaegis hook bash)
```
## License
This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for the full license text.

BIN
assets/images/list.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB