obs-scheduler 0.0.1 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +17 -1
  2. package/cli.js +2 -2
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,11 +1,27 @@
1
1
  # obs-scheduler
2
2
 
3
+ ![NPM Version](https://img.shields.io/npm/v/obs-scheduler?color=%23302E31)
4
+ ![Static Badge](https://img.shields.io/badge/OBS-302E31?logo=obsstudio)
5
+
3
6
  A CLI for scheduling actions in OBS.
4
7
 
8
+ ## Install
9
+
10
+ ```shell
11
+ npm install -g obs-scheduler
12
+ ```
13
+
5
14
  ## Usage
6
15
 
7
16
  ```shell
8
- obs-scheduler -c scheduler-config.json -p
17
+ Usage: obs-scheduler [options]
18
+
19
+ Options:
20
+ -V, --version output the version number
21
+ -c, --config <file-path> config file path
22
+ -i, --ip-address [address:port] OBS Websocket IP address and port
23
+ -p, --password [password] OBS Websocket password
24
+ -h, --help display help for command
9
25
  ```
10
26
 
11
27
  ## Examples
package/cli.js CHANGED
@@ -6,8 +6,6 @@ import { program } from "commander";
6
6
 
7
7
  program
8
8
  .name('obs-scheduler')
9
- .version('0.0.1')
10
- .option('-c, --config <file-path>', 'config file path')
11
9
  .option(
12
10
  '-i, --ip-address [address:port]',
13
11
  'OBS Websocket IP address and port',
@@ -18,6 +16,8 @@ program
18
16
  'OBS Websocket password',
19
17
  undefined,
20
18
  )
19
+ .option('-c, --config <file-path>', 'config file path')
20
+ .version('0.0.3')
21
21
  .action(run);
22
22
 
23
23
  await program.parseAsync(process.argv);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "obs-scheduler",
3
- "version": "0.0.1",
3
+ "version": "0.0.3",
4
4
  "description": "A CLI tool for scheduling OBS functionality.",
5
5
  "author": "edonv",
6
6
  "type": "module",