Skip to content

Commit ab62e4b

Browse files
authored
update readme to reflect system support
1 parent 4be7e1f commit ab62e4b

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
1-
# League of Foundry VTT Developers Bug Reporter
1+
# :bug: Bug Reporter
22

3-
This module allows users to search for and sometimes create github issues for a module within the foundry UI.
3+
This module allows users to search for and sometimes create github issues for a module or system within the foundry UI.
44

55
## Features
66
- Form will display a warning if the user is not up to date first.
7-
- Any module with a compatible `bugs` url in the manifest will allow searching that module's issue list for matching titles.
8-
- For opted-in modules, a form within Foundry will submit a bug report.
9-
- For non-opted-in modules, a link to the module's github issues list will be displayed.
7+
- Any module or system with a compatible `bugs` url in the manifest will display a link to the module's github issues list will be displayed.
8+
- For opted-in modules, a form within Foundry will submit a bug report after first searching that package's issue list for similar matches.
109

1110
![The Bug Submission Form](/form-flow.png)
1211

@@ -24,7 +23,7 @@ This module allows users to search for and sometimes create github issues for a
2423

2524
### How does it work?
2625

27-
The module looks at all activated modules which have both `allowBugReporter: true` and a `bugs` field which meets the following criteria in the manifest:
26+
The module looks at all activated modules and the system which have both `allowBugReporter: true` and a `bugs` field which meets the following criteria in the manifest:
2827
1. is a Github repo
2928
2. ends in `/issues`
3029

0 commit comments

Comments
 (0)