From 6d1c2172abdef30fb5b8bb5ef41ee63cecb57c6a Mon Sep 17 00:00:00 2001
From: Antonin Portelli <antonin.portelli@me.com>
Date: Sat, 26 Mar 2022 00:33:28 +0000
Subject: [PATCH] readme

---
 Readme.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 Readme.md

diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..5f43123
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,17 @@
+# CLI for Atempo Miria tape archive
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
+Command line tools to interact with an Atempo Miria tape archive.
+All commands rely on the Miria Webservices API, and assume that the user
+has a `.miria` file in their home directory with the form
+```
+url <url>
+agent <hostname>
+```
+where `<url>` is the API URL generated with
+```
+ada_service -build_url | -build_url_s -identity <user>:<password>
+```
+(e.g. `http://adadoc:85/meta/BD117E7D5CF0912AEA17B4DF33D63F7E/721b766531/ADA/WS`)
+and  `<hostname>` is the host name of the Miria agent mounting the local
+filesystem.