chore: readme

taiyuuki · Nov 4, 2023 · 7eae159 · 7eae159
1 parent 2b93c16
commit 7eae159
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+# EPUB Images extractor
+
+[![Build Status](https://travis-ci.org/taiyuuki/ei-extractor.svg?branch=master)](https://travis-ci.org/taiyuuki/ei-extractor)
+
+ei-extractor is a command tool to extract images from EPUB files. 
+
+## Download
+
+- [Windows](https://github.com/taiyuuki/ei-extractor/releases/download/0.1.0/ei-extractor.exe)
+
+```bash
+curl -L https://github.com/taiyuuki/ei-extractor/releases/download/0.1.0/ei-extractor.exe -o ei-extractor.exe
+```
+
+## Usage
+
+```bash
+Usage: ei-extractor.exe <EPUB File>
+
+Arguments:
+  <EPUB File>
+
+Options:
+  -h, --help     Print help
+  -V, --version  Print version
+```