-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: fix generate docs and expand on getting started (#102)
- Loading branch information
Showing
3 changed files
with
78 additions
and
16 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 |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Basic generator | ||
|
||
The basic generator looks at the `key:""`, `desc:""` and `default:""` tags on service configuration structs and uses them to ask the user to fill in their corresponding values. | ||
|
||
Example: | ||
```shell | ||
$ shoutrrr generate telegram | ||
``` | ||
```yaml | ||
Generating URL for telegram using basic generator | ||
Enter the configuration values as prompted | ||
|
||
Token: 110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw | ||
Preview[Yes]: No | ||
Notification[Yes]: | ||
ParseMode[None]: | ||
Channels: @mychannel | ||
|
||
URL: telegram://110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw@telegram?channels=@mychannel¬ification=Yes&parsemode=None&preview=No | ||
``` |
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 |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Generators | ||
|
||
Generators are used to create service configurations via the command line. | ||
The main generator is the reflection based [Basic generator](./basic) that aims to be able to generator configurations for all the core services via a set of simple questions. | ||
|
||
## Usage | ||
|
||
```bash | ||
$ shoutrrr generate [OPTIONS] -g <GENERATOR> <SERVICE> | ||
``` |
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