Skip to content

Commit d4f15ac

Browse files
authored
Merge pull request #32 from danielparks/development-status
README.md: Add section about development status.
2 parents 8b24a64 + 60b2224 commit d4f15ac

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
44

55
## main branch
66

7+
* Added a section about development status (stable; no features planned) to
8+
[README.md][].
9+
10+
[README.md]: README.md
11+
712
## Release 1.2.3
813

914
No functional changes. This release is solely to keep the released module from

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,14 @@ golang::linked_binaries { '/home/me/go':
8888

8989
This does not support Windows.
9090

91+
## Development status
92+
93+
This is stable. I have no features planned for the future, though I’m open to
94+
[suggestions][issues].
95+
96+
I will occasionally make 0.0.1 releases to keep this updated with the latest
97+
version of [PDK][].
98+
9199
## Reference
92100

93101
There is specific documentation for individual parameters in [REFERENCE.md][].
@@ -97,7 +105,6 @@ That file is generated with:
97105
pdk bundle exec puppet strings generate --format markdown
98106
```
99107

100-
[REFERENCE.md]: REFERENCE.md
101108
[`golang`]: REFERENCE.md#golang
102109
[$golang::ensure]: REFERENCE.md#-golang--ensure
103110
[`golang::installation`]: REFERENCE.md#golang--installation
@@ -106,3 +113,6 @@ pdk bundle exec puppet strings generate --format markdown
106113
[$g::i::group]: REFERENCE.md#-golang--installation--group
107114
[`golang::linked_binaries`]: REFERENCE.md#golang--linked_binaries
108115
[hiera]: https://puppet.com/docs/puppet/latest/hiera.html
116+
[issues]: https://github.com/danielparks/puppet-golang/issues
117+
[PDK]: https://github.com/puppetlabs/pdk
118+
[REFERENCE.md]: REFERENCE.md

0 commit comments

Comments
 (0)