-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(docs): add basic usage instructions
- Loading branch information
1 parent
719fe5c
commit 4c85345
Showing
1 changed file
with
40 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,43 @@ | ||
# midi-mixer-cli | ||
|
||
A CLI tool to help with the packaging and distribution of MIDI Mixer plugins. | ||
|
||
``` | ||
Usage: midi-mixer [options] [command] | ||
A CLI tool to help with the packaging and distribution of MIDI Mixer plugins. | ||
Options: | ||
-V, --version output the version number | ||
-h, --help display help for command | ||
Commands: | ||
pack [options] Package a plugin ready for distribution. | ||
help [command] display help for command | ||
``` | ||
|
||
## Packaging plugins | ||
|
||
Use the `midi-mixer pack` command to package a built plugin in to a `.midiMixerPlugin` file ready for distribution. | ||
|
||
``` | ||
Usage: midi-mixer pack [options] | ||
Package a plugin ready for distribution. | ||
Options: | ||
-m --manifest <path> target plugin.json file | ||
-h, --help display help for command | ||
``` | ||
|
||
``` | ||
> midi-mixer pack | ||
√ Finding plugin manifest | ||
√ Verifying manifest shape | ||
√ Verifying manifest targets | ||
√ Package | ||
√ Finalising | ||
``` | ||
|
||
For a plugin with the name `foo` on version `1.0.0`, the plugin file generated would be called `foo-1.0.0.midiMixerPlugin`. |