Skip to content

Commit 83d1339

Browse files
Fix README placeholders
1 parent d44c807 commit 83d1339

1 file changed

Lines changed: 4 additions & 62 deletions

File tree

README.md

Lines changed: 4 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,11 @@
11
# OpenAI
22

3-
A PowerShell module template that can be used to create new modules.
3+
OpenAI is intended to be a PowerShell module for interacting with OpenAI.
44

5-
## Prerequisites
5+
## Status
66

7-
This uses the following external resources:
8-
- The [PSModule framework](https://github.com/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 YourModuleName
16-
Import-Module -Name YourModuleName
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'.
46-
47-
## Documentation
48-
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.
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.
518

529
## Contributing
5310

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+
Issues and pull requests are welcome when implementation work begins.

0 commit comments

Comments
 (0)