From 1422f4135582abdd408773d077e0508643f1d473 Mon Sep 17 00:00:00 2001 From: iceberg53 Date: Wed, 31 Jan 2024 17:43:27 +0100 Subject: [PATCH] Add instructions on how to install gen-subs Add explicitly the shell command to run for installing gen-subs to make it easier for those new to the nodejs ecosystem. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index bcfb8b4..4616368 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,16 @@ https://github.com/TejasQ/gen-subs/assets/9947422/bc8df523-b62a-4123-a62d-2df178 - 🎧 **Multi-modal** - Supports both audio and video files and generates subtitles for each. - 📊 **Multi-model** - Choose from a variety of machine learning models ranging from 40MB to >2GB in size. The larger the model, the more accurate the subtitles, but smaller models are also quite capable. +## Installation + +To install gen-subs globally, run the following command : + +```bash +npm i -g gen-subs +``` + +It's also possible to install it on a per project basis by omitting the -g flag. + ## Usage You can generate subtitles for any video using the following command: