Skip to content

Commit da37361

Browse files
📝 [Docs]: Add expected repository structure section to README
1 parent 8cccec4 commit da37361

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ This step lets you add custom build logic to process or modify the module conten
3636
| `Prerelease` | Allow prerelease versions if available. | `false` | `'false'` |
3737
| `WorkingDirectory` | The working directory where the script runs. | `false` | `'.'` |
3838

39+
## Expected repository structure
40+
41+
The action expects the module repository to be structured similarly as [Template-PSModule](https://github.com/PSModule/Template-PSModule).
42+
3943
## Root module
4044

4145
The `src` folder may contain a 'root module' file. If present, the build function will disregard this file and build a new root module file based on the source code in the module folder.
@@ -151,7 +155,7 @@ Linking the description to the module manifest file might show more how this wor
151155

152156
This action does not require any special permissions.
153157

154-
## Sources
158+
## References
155159

156160
**Module manifest:**
157161

0 commit comments

Comments
 (0)