Skip to content

Commit 140cb28

Browse files
Fix README placeholders
1 parent 3f5eb7d commit 140cb28

1 file changed

Lines changed: 30 additions & 39 deletions

File tree

README.md

Lines changed: 30 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,60 @@
1-
# {{ NAME }}
1+
# MemoryMappedFile
22

3-
{{ DESCRIPTION }}
3+
MemoryMappedFile is a PowerShell module for creating, reading, writing, and closing named memory-mapped files.
44

55
## Prerequisites
66

7-
This uses the following external resources:
8-
- The [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing and publishing the module.
7+
- PowerShell with `Microsoft.PowerShell.PSResourceGet` available for `Install-PSResource`.
8+
- The [PSModule framework](https://github.com/PSModule) is used for building, testing, and publishing the module.
99

1010
## Installation
1111

12-
To install the module from the PowerShell Gallery, you can use the following command:
12+
Install the module from the PowerShell Gallery:
1313

1414
```powershell
15-
Install-PSResource -Name {{ NAME }}
16-
Import-Module -Name {{ NAME }}
15+
Install-PSResource -Name MemoryMappedFile
16+
Import-Module -Name MemoryMappedFile
1717
```
1818

19-
## Usage
19+
## Commands
2020

21-
Here is a list of example that are typical use cases for the module.
21+
- `New-MemoryMappedFile` creates a named memory-mapped file from a backing file path.
22+
- `Set-MemoryMappedFile` returns an existing map by name or creates it when missing.
23+
- `Get-MemoryMappedFile` opens an existing named map.
24+
- `Set-MemoryMappedFileContent` writes UTF-8 string content to a named map.
25+
- `Read-MemoryMappedFileContent` reads UTF-8 string content from a named map.
26+
- `Show-MemoryMappedFile` displays map content repeatedly in the console.
27+
- `Close-MemoryMappedFile` disposes a named map.
2228

23-
### Example 1: Greet an entity
29+
## Usage
2430

25-
Provide examples for typical commands that a user would like to do with the module.
31+
Create or open a map backed by a file:
2632

2733
```powershell
28-
Greet-Entity -Name 'World'
29-
Hello, World!
34+
Set-MemoryMappedFile -Name 'SharedMap' -Path './shared.dat' -Size 2MB
3035
```
3136

32-
### Example 2
33-
34-
Provide examples for typical commands that a user would like to do with the module.
37+
Write and read string content:
3538

3639
```powershell
37-
Import-Module -Name PSModuleTemplate
40+
Set-MemoryMappedFileContent -Name 'SharedMap' -Path './shared.dat' -Content 'Hello from PowerShell'
41+
Read-MemoryMappedFileContent -Name 'SharedMap'
3842
```
3943

40-
### Find more examples
44+
Close the map when finished:
45+
46+
```powershell
47+
Close-MemoryMappedFile -Name 'SharedMap'
48+
```
4149

42-
To find more examples of how to use the module, please refer to the [examples](examples) folder.
50+
## Examples
4351

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'.
52+
More usage examples are available in the [examples](examples) folder.
4653

4754
## Documentation
4855

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.
56+
Command documentation is published at [psmodule.io/MemoryMappedFile](https://psmodule.io/MemoryMappedFile/).
5157

5258
## Contributing
5359

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.
60+
Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.

0 commit comments

Comments
 (0)