From 3c727ab282d2a6cc0a3668a787c523966da8a4eb Mon Sep 17 00:00:00 2001 From: "Glenn Y. Rolland" Date: Fri, 19 Aug 2022 12:12:59 +0200 Subject: [PATCH] doc: Update README --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b84b625..60d0aca 100644 --- a/README.md +++ b/README.md @@ -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