Skip to content

Commit 2194e02

Browse files
committed
docs: Remove unnecessary things from ReadMe
1 parent 0592702 commit 2194e02

File tree

1 file changed

+11
-51
lines changed

1 file changed

+11
-51
lines changed

ReadMe.md

Lines changed: 11 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,6 @@
22

33
🚧 This repo is still a work in progress and not yet ready to be used 🚧
44

5-
Things to still do:
6-
7-
- Create new deployment on tag creation maybe
8-
- Add instructions for how to assign version number in the contributing docs depending on if they are using actions or pipelines
9-
- 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
10-
- Show instructions for granting GitHub permissions etc. during the prompt script
11-
- Rename function to Get-TemplateDescription or similar and have it explain the module and a link to it.
12-
- Make azure DevOps and GitHub steps in the ReadMe collapsible.
13-
Have screenshots and link to recording of the setup in both, since they involve clicking around in the UI.
14-
- In the ReadMe setup instructions or above, have a sentence or two explaining the layout of the ReadMe, or maybe a table of contents
15-
- Add some badges as well to the ReadMe.
16-
175
A template repository to create new PowerShell modules quickly with boilerplate files and CI/CD workflows already defined.
186

197
## ✨ Features
@@ -132,44 +120,16 @@ Buy me a hot apple cider for providing this template open source and for free
132120

133121
[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=5MWSTSXNYEJWW)
134122

135-
### ❌ Step 8: Remove this section and everything above once setup is complete
136-
137-
> [!IMPORTANT]
138-
> All of the information above can be deleted once you have your module setup and the CI/CD pipeline workflows are working.
139-
>
140-
> Modify the information below for your new module, or just delete it all to have a blank canvas.
141-
142-
---
143-
144-
## 💬 Description
123+
## TODO
145124

146-
A short description of what this project does.
147-
148-
## ❓ Why this exists
149-
150-
A short description of why this project exists.
151-
What use-case is it meant to solve?
152-
153-
## ✨ Features
154-
155-
List the features of this project:
156-
157-
- Feature 1
158-
- Feature 2
159-
160-
## 🚀 Quick start
161-
162-
A quick guide on how to get started with this module, including installation and usage:
163-
164-
- A link to the module in the PowerShell Gallery.
165-
- Code snippets of installing and using the module.
166-
- Links to wiki or other documentation.
167-
168-
## ➕ How to contribute
169-
170-
Issues and Pull Requests are welcome.
171-
See [the Contributing page](docs/Contributing.md) for more details.
172-
173-
## 📃 Changelog
125+
Things to still do:
174126

175-
See what's changed in the application over time by viewing [the changelog](Changelog.md).
127+
- Create new deployment on tag creation maybe
128+
- Add instructions for how to assign version number in the contributing docs depending on if they are using actions or pipelines
129+
- 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
130+
- Show instructions for granting GitHub permissions etc. during the prompt script
131+
- Rename function to Get-TemplateDescription or similar and have it explain the module and a link to it.
132+
- Make azure DevOps and GitHub steps in the ReadMe collapsible.
133+
Have screenshots and link to recording of the setup in both, since they involve clicking around in the UI.
134+
- In the ReadMe setup instructions or above, have a sentence or two explaining the layout of the ReadMe, or maybe a table of contents
135+
- Add some badges as well to the ReadMe.

0 commit comments

Comments
 (0)