Skip to content
This repository was archived by the owner on Apr 13, 2025. It is now read-only.

Commit 4e9699d

Browse files
committed
docs(README): add readme section about nodecg-io generate
1 parent 5668899 commit 4e9699d

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ This is the cli for [nodecg-io](https://github.com/codeoverflow-org/nodecg-io) t
1313
- [Commands](#commands)
1414
- [`nodecg-io install`](#nodecg-io-install)
1515
- [`nodecg-io uninstall`](#nodecg-io-uninstall)
16+
- [`nodecg-io generate`](#nodecg-io-generate)
1617
- [A note about versioning](#a-note-about-versioning)
1718
- [Developer workflow](#developer-workflow)
1819

@@ -38,6 +39,17 @@ If you later decide that you want to add or remove a service you can just re-run
3839

3940
Undos everything that `nodecg-io install` did. It removes the `nodecg-io` directory with your installation and removes nodecg-io from your nodecg configuration.
4041

42+
### `nodecg-io generate`
43+
44+
Generates a new bundle in the `bundles/` directory in your nodecg installation.
45+
Allows you to decide on language (typescript or javascript), whether you want a dashboard/graphic and which services you want to use.
46+
Uses your installed nodecg-io version and services, meaning you need to have the services that you want to use installed.
47+
48+
These generated bundles are only meant as a starting point, you may probably do more things like creating a git repository for your bundle,
49+
add a license, or add other tools like linters.
50+
51+
Also this command currently only works with installs of released versions and not with development installs. This is because all bundles using nodecg-io depend on `nodecg-io-core` and if you use typescript each used service as well. For development installs these are not published on npm and you would need some way of linking the packages locally.
52+
4153
## A note about versioning
4254

4355
This cli follows and is versioned independently from the rest of nodecg-io like `nodecg-io-core` or the services.

0 commit comments

Comments
 (0)