From 5a528e92c2d8eb057a87f63c354a123bb0eca6b4 Mon Sep 17 00:00:00 2001
From: Romain de Laage <romain.delaage@rdelaage.ovh>
Date: Tue, 4 May 2021 15:29:44 +0200
Subject: [PATCH] Add readme

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..25b9f80
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# Gempub validator
+
+Gempub is a new eBook format based on Gemini Protocol's Gemtext. Gempub can also serve as a Gemini capsule archive format. This program aims to validate a `gpub` file, if it is an archive it will verify that there is a `index.gmi` file at the root of the archive and if it is a book it will verify both `metadata.txt` and content.
+
+[Gempub specifications](https://codeberg.org/oppenlab/gempub)
+
+## Requirement
+
+* Go compiler (1.16+, lower versions could work but not tested)
+
+## How to build
+
+```
+go build
+```
+
+## How to use
+
+```
+./main filename
+```
+
+Where `filename` is the name of your gempub file.
+
+*This program is released under a GPLv3 license*