|
1 | | -# {{ NAME }} |
| 1 | +# Domeneshop |
2 | 2 |
|
3 | | -{{ DESCRIPTION }} |
| 3 | +Domeneshop is intended to be a PowerShell module for interacting with the Domeneshop APIs. |
4 | 4 |
|
5 | | -## Prerequisites |
| 5 | +## Status |
6 | 6 |
|
7 | | -This uses the following external resources: |
8 | | -- The [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing and publishing the module. |
9 | | - |
10 | | -## Installation |
11 | | - |
12 | | -To install the module from the PowerShell Gallery, you can use the following command: |
13 | | - |
14 | | -```powershell |
15 | | -Install-PSResource -Name {{ NAME }} |
16 | | -Import-Module -Name {{ NAME }} |
17 | | -``` |
18 | | - |
19 | | -## Usage |
20 | | - |
21 | | -Here is a list of example that are typical use cases for the module. |
22 | | - |
23 | | -### Example 1: Greet an entity |
24 | | - |
25 | | -Provide examples for typical commands that a user would like to do with the module. |
26 | | - |
27 | | -```powershell |
28 | | -Greet-Entity -Name 'World' |
29 | | -Hello, World! |
30 | | -``` |
31 | | - |
32 | | -### Example 2 |
33 | | - |
34 | | -Provide examples for typical commands that a user would like to do with the module. |
35 | | - |
36 | | -```powershell |
37 | | -Import-Module -Name PSModuleTemplate |
38 | | -``` |
39 | | - |
40 | | -### Find more examples |
41 | | - |
42 | | -To find more examples of how to use the module, please refer to the [examples](examples) folder. |
43 | | - |
44 | | -Alternatively, you can use the Get-Command -Module 'This module' to find more commands that are available in the module. |
45 | | -To find examples of each of the commands you can use Get-Help -Examples 'CommandName'. |
| 7 | +This repository is currently a placeholder. The module source still contains scaffold code, so there are no supported commands or usage examples to document yet. |
46 | 8 |
|
47 | 9 | ## Documentation |
48 | 10 |
|
49 | | -Link to further documentation if available, or describe where in the repository users can find more detailed documentation about |
50 | | -the module's functions and features. |
51 | | - |
52 | | -## Contributing |
53 | | - |
54 | | -Coder or not, you can contribute to the project! We welcome all contributions. |
55 | | - |
56 | | -### For Users |
57 | | - |
58 | | -If you don't code, you still sit on valuable information that can make this project even better. If you experience that the |
59 | | -product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests. |
60 | | -Please see the issues tab on this project and submit a new issue that matches your needs. |
61 | | - |
62 | | -### For Developers |
63 | | - |
64 | | -If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information. |
65 | | -You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement. |
66 | | - |
67 | | -## Acknowledgements |
68 | | - |
69 | | -Here is a list of people and projects that helped this project in some way. |
| 11 | +Documentation is not published yet because this module is still a placeholder. Once the module is implemented, command details will live in PowerShell help and generated documentation rather than being duplicated in this README. |
0 commit comments