From 36138f382286fd02fc905eff6a7d2678c26264a0 Mon Sep 17 00:00:00 2001
From: Louis Vallat <louis@louis-vallat.xyz>
Date: Wed, 2 Feb 2022 10:50:59 +0100
Subject: [PATCH] Added README

Signed-off-by: Louis Vallat <louis@louis-vallat.xyz>
---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3799ead
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# Mettallibruh
+
+> Generates new and original lyrics from a set of existing lyrics.
+
+## Format
+
+The input file should be formatted such as:
+
+- one line <=> one sentence
+- sentences should end with dots, always
+
+## How to use
+
+```bash
+cargo run --release -- ./input
+```
+
+> This was made as a quick implementation for an idea.
+