doc: Update README

This commit is contained in:
Glenn Y. Rolland 2022-08-19 12:12:59 +02:00
parent 99f33f84e6
commit 3c727ab282

View file

@ -1,9 +1,34 @@
# Arkisto
A simple tool to automate openstack snapshots management
[![Build Status](https://cicd.apps.glenux.net/api/badges/glenux/arkisto/status.svg?ref=refs/heads/develop)](https://cicd.apps.glenux.net/glenux/arkisto)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Donate on patreon](https://img.shields.io/badge/patreon-donate-orange.svg)](https://patreon.com/glenux)
A simple tool to automate and manage openstack snapshots
## Installation
### With docker
Make sure you have Docker and Make installed. Then type
make docker-build
### Manual
Make sure you have installed the following software on your system:
* Crystal
* Make
* libevent-core-2.1-7
* python-openstackclient
Then type
make build
## Usage
## Licence