Skip to content

Commit 909fd63

Browse files
authored
docs: update README for Nextflow plugin registry compliance (#55)
## Summary - Rename "Quick Start" → "Get Started" to match the registry's required section names - Use absolute GitHub URL for the notification screenshot so it renders on the registry - Add "Examples" section with bot configuration snippets (bot-only, no webhooks) The Nextflow plugin registry requires README.md to include **Summary**, **Get Started**, **Examples**, and **License** sections. The `releasePlugin` Gradle task already sends the README as the documentation field — these changes ensure it passes registry validation and renders correctly.
1 parent 2e46e53 commit 909fd63

1 file changed

Lines changed: 36 additions & 2 deletions

File tree

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Get Slack notifications for your Nextflow workflows — automatically notified w
1414
- **Threading, Reactions, and Progress Updates** — Keep channels organized
1515
- **Seqera Platform Integration** — One-click navigation to your runs
1616

17-
## Quick Start
17+
## Get Started
1818

1919
Add to your `nextflow.config`:
2020

@@ -34,7 +34,7 @@ slack {
3434

3535
Run your pipeline — you'll get Slack notifications automatically:
3636

37-
![Default notifications](./docs/images/nf-slack-00.png)
37+
![Default notifications](https://raw.githubusercontent.com/seqeralabs/nf-slack/main/docs/images/nf-slack-00.png)
3838

3939
See the [Setup Guide](https://seqeralabs.github.io/nf-slack/latest/getting-started/setup/) for bot and webhook configuration options.
4040

@@ -46,6 +46,40 @@ See the [Setup Guide](https://seqeralabs.github.io/nf-slack/latest/getting-start
4646
- **[API Reference](https://seqeralabs.github.io/nf-slack/latest/reference/api/)** — All configuration options
4747
- **[Contributing](docs/CONTRIBUTING.md)** — Development setup and guidelines
4848

49+
## Examples
50+
51+
Here are a few common configurations to get you started:
52+
53+
**Basic bot notifications:**
54+
55+
```groovy
56+
slack {
57+
enabled = true
58+
bot {
59+
token = 'xoxb-your-bot-token'
60+
channel = 'pipeline-results'
61+
}
62+
}
63+
```
64+
65+
**Threaded messages with start, complete, and error events:**
66+
67+
```groovy
68+
slack {
69+
enabled = true
70+
bot {
71+
token = 'xoxb-your-bot-token'
72+
channel = 'pipeline-results'
73+
}
74+
useThreads = true
75+
onStart.send = true
76+
onComplete.send = true
77+
onError.send = true
78+
}
79+
```
80+
81+
See the [Examples Gallery](https://seqeralabs.github.io/nf-slack/latest/examples/gallery/) for more copy-paste configurations.
82+
4983
## Support
5084

5185
- [Report bugs](https://github.com/seqeralabs/nf-slack/issues)

0 commit comments

Comments
 (0)