From 143b7b51b2e45dcdfa3cbb8e5148a0073521bc52 Mon Sep 17 00:00:00 2001 From: Chaphasilor Date: Mon, 24 May 2021 20:32:59 +0200 Subject: [PATCH] update readme --- README.md | 40 ++++++++++++++++++---------------------- 1 file changed, 18 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 805eaba..dd488a6 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,28 @@ -video-sync -========== +# video-sync - - -[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) -[![Version](https://img.shields.io/npm/v/video-sync.svg)](https://npmjs.org/package/video-sync) -[![Downloads/week](https://img.shields.io/npm/dw/video-sync.svg)](https://npmjs.org/package/video-sync) -[![License](https://img.shields.io/npm/l/video-sync.svg)](https://github.com/Chaphasilor/video-sync/blob/master/package.json) +--- -* [Usage](#usage) -* [Commands](#commands) +- [video-sync](#video-sync) + - [Usage](#usage) + - [Arguments](#arguments) -# Usage + +## Usage + ```sh-session -$ npm install -g video-sync -$ video-sync COMMAND -running command... -$ video-sync (-v|--version|version) -video-sync/1.0.0 linux-x64 node-v14.16.0 -$ video-sync --help [COMMAND] -USAGE - $ video-sync COMMAND +$ video-sync # interactive mode +... +$ video-sync video1 offset1 video2 offset2 -o output # CLI mode +... +$ video-sync -h # help page ... ``` + -# Commands - - +## Arguments + + +