Skip to content

Commit efb1fe7

Browse files
committed
docs: Update ReadMe a bit
1 parent 0bc1497 commit efb1fe7

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

ReadMe.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@
2222

2323
# PowerShell Script Module Repository Template
2424

25-
A template repository and module for creating new PowerShell module repos quickly with boilerplate files and CI/CD workflows already defined.
25+
A template repository and module for creating new PowerShell script module repos quickly with boilerplate files and CI/CD workflows already defined.
2626

2727
## ✨ Features
2828

2929
Use this repo template or module for your new git repository to get the following features out-of-the-box:
3030

31-
- GitHub Actions workflows or Azure DevOps Pipelines YAML files that:
31+
- GitHub Actions workflows (Azure DevOps Pipelines YAML support coming soon) that:
3232
- Publish a prerelease version on every commit to the `main` branch, and a stable version once manually approved.
3333
- Can also manually trigger deployments of feature branches.
3434
- Version the module.
@@ -41,6 +41,8 @@ Use this repo template or module for your new git repository to get the followin
4141
- A `.devcontainer` for use with Visual Studio Code's [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) and [GitHub Codespaces](https://github.com/features/codespaces).
4242
- Boilerplate repository files, such as ReadMe, License, Changelog, .gitignore, .editorconfig, PR and Issue templates, and more.
4343

44+
This template/module does not require any additional modules or dependencies to be installed on your machine, or force you to learn a new build framework or language.
45+
4446
## 🚀 Get started
4547

4648
There are two ways to create your new PowerShell module repository:
@@ -128,14 +130,10 @@ Buy me a hot apple cider for providing this template open source and for free
128130

129131
Things to still do:
130132

133+
- Add support for Azure DevOps.
131134
- Allow user to create single .psm1 file or Public/Private directory structure for separate files per function.
132135
- Allow using a custom PowerShell Gallery feed URL.
133-
- Create new deployment on tag creation maybe.
134-
- Prompt user for module name, org name, pipelines or actions, PowerShell gallery or custom feed with an option to leave it blank to fill it in later.
135136
- Make azure DevOps and GitHub steps in the ReadMe collapsible.
136-
Have screenshots and link to recording of the setup in both, since they involve clicking around in the UI.
137-
Perhaps link to [this tutorial](https://dev.to/olalekan_oladiran_d74b7a6/how-to-enable-continuous-integration-with-azure-pipelines-1doi)?
138-
- In the ReadMe setup instructions or above, have a sentence or two explaining the layout of the ReadMe, or maybe a table of contents
139-
- To prevent having to store CI/CD manual setup images in the repo, maybe have them as an external link to a GitHub branch.
140-
- Also create videos showing how to do the setup.
141-
- Maybe show instructions for setting up GitHub / Azure DevOps CI/CD during the initialization script. Or mention to follow the ReadMe instructions.
137+
Have screenshots and links to a recording of the setup in both, since they involve clicking around in the UI.
138+
Perhaps link to [this tutorial for Azure DevOps](https://dev.to/olalekan_oladiran_d74b7a6/how-to-enable-continuous-integration-with-azure-pipelines-1doi)?
139+
- Maybe support new deployments on tag creation.

0 commit comments

Comments
 (0)