From 31659af679be79e7e08fba21ca34cec1d465da8e Mon Sep 17 00:00:00 2001
From: abk16 <and.theunnamed@gmail.com>
Date: Sun, 17 Mar 2024 10:51:16 +0100
Subject: [PATCH] docs: add basic README file with install and usage
 instructions

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e02e95a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# WhisperSubs
+
+[![License](https://img.shields.io/github/license/andreabak/whispersubs)](https://github.com/andreabak/whispersubs/blob/main/LICENSE)
+[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/andreabak/whispersubs/pre-commit?branch=main
+)](https://github.com/andreabak/whispersubs/actions)
+[![Python 3.8](https://img.shields.io/badge/python-3.8-blue.svg)](https://www.python.org/downloads/release/python-380/)
+
+Generate subtitles for your video or audio files using the power of AI.
+
+## Installation
+
+Prerequisites:
+- git for cloning this repo
+- Python 3.8 or higher, with pip
+
+For faster results, it is recommended to use a GPU with CUDA support.
+
+```shell
+# Clone the repo and cd into it
+git clone https://github.com/andreabak/whispersubs.git
+cd whispersubs
+
+# Install the dependencies
+pip install -r requirements.txt
+```
+
+## Usage
+WhisperSubs can be used from the command line. The basic usage requires an input file, which will be the source for the transcription. The output will be a subtitle file in the SRT format in the same directory as the input file. The language will be automatically detected.
+```shell
+python -m whispersubs <input_file>
+```
+
+For a full list of options, run:
+```shell
+python -m whispersubs --help
+```