From e8c2d5c43a23fc6e3824f89c944fa93237b42e49 Mon Sep 17 00:00:00 2001
From: Keuin <keuinx@gmail.com>
Date: Wed, 31 May 2023 01:02:20 +0800
Subject: Support multiple CJK provider. Accept CLI arguments and STDIN input.

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..148087b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+utaten2tex: convert lyrics from `utaten.com` to LaTeX
+
+Usage: <main.py> [path_to_html_file]
+
+If HTML file is not specified, the program will read HTML text from STDIN.
+
+Example:
+
+```shell
+curl https://utaten.com/lyric/sa16080309/ | python3 main.py
+```
+
+Make sure you have `beautifulsoup` and `html5lib` installed.
\ No newline at end of file
-- 
cgit v1.2.3