Skip to content

Commit c433455

Browse files
committed
docs: 📝 update README with enhanced features and documentation
- improve project description and badges - add documentation and contributors section - clarify license information
1 parent 319b888 commit c433455

1 file changed

Lines changed: 41 additions & 5 deletions

File tree

README.md

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,24 @@
1-
# DevContainer Features by helpers4
1+
<h1 align="center">helpers4 — DevContainer Features</h1>
22

3-
This repository contains a collection of DevContainer Features developed and maintained by helpers4.
3+
<p align="center">
4+
<strong>Production-ready DevContainer Features for instant, reproducible development environments.</strong>
5+
</p>
46

5-
Published at: `ghcr.io/helpers4/devcontainer/<feature-name>`
7+
<p align="center">
8+
<a href="https://github.com/helpers4/devcontainer/blob/main/LICENSE"><img src="https://img.shields.io/github/license/helpers4/devcontainer?color=blue" alt="license" /></a>
9+
<a href="https://github.com/helpers4/devcontainer"><img src="https://img.shields.io/github/last-commit/helpers4/devcontainer" alt="last commit" /></a>
10+
<a href="https://containers.dev/features"><img src="https://img.shields.io/badge/devcontainer-features-blue?logo=visual-studio-code&logoColor=white" alt="DevContainer Features" /></a>
11+
</p>
12+
13+
---
14+
15+
## Overview
16+
17+
This repository contains a collection of DevContainer Features developed and maintained by the helpers4 organization. All features are published to the GitHub Container Registry and can be referenced directly in any `devcontainer.json`.
18+
19+
```
20+
ghcr.io/helpers4/devcontainer/<feature-name>
21+
```
622

723
## Features
824

@@ -176,6 +192,10 @@ Features from this repository are available via GitHub Container Registry. Refer
176192
| [local-mounts](./features/local-mounts) | Mount local Git, SSH, GPG, and npm config into devcontainer | [README](./features/local-mounts/README.md) |
177193
| [peon-ping](./features/peon-ping) | AI agent sound notifications with multi-IDE hooks and Peon Pet extension | [README](./features/peon-ping/README.md) |
178194

195+
## Documentation
196+
197+
Full documentation is available at [**helpers4.dev/dev-container**](https://helpers4.dev/dev-container).
198+
179199
## Development
180200

181201
This repository follows the [DevContainer Features specification](https://containers.dev/implementors/features/) and is compatible with the [DevContainer Features distribution](https://containers.dev/implementors/features-distribution/).
@@ -194,6 +214,8 @@ Features are automatically published to GitHub Container Registry via GitHub Act
194214

195215
## Contributing
196216

217+
Contributions are welcome! Please follow the established feature structure and test your changes locally before submitting.
218+
197219
1. Fork the repository
198220
2. Create a feature branch
199221
3. Add your feature following the established patterns
@@ -202,8 +224,22 @@ Features are automatically published to GitHub Container Registry via GitHub Act
202224

203225
## License
204226

205-
This project is licensed under the GNU Lesser General Public License v3.0. See [LICENSE](LICENSE) for details.
227+
This project is licensed under the [GNU Lesser General Public License v3.0](LICENSE).
206228

207229
## Acknowledgments
208230

209-
Inspired by the [DevContainers Features](https://github.com/devcontainers/features) repository and [stuart leeks' dev-container-features](https://github.com/stuartleeks/dev-container-features) for the shell-history concept, with the key difference being project-scoped rather than global user history persistence.
231+
Inspired by the official [DevContainers Features](https://github.com/devcontainers/features) repository and [Stuart Leeks' dev-container-features](https://github.com/stuartleeks/dev-container-features) for the shell-history concept — with the key difference being project-scoped rather than global user history persistence.
232+
233+
## Contributors
234+
235+
<table>
236+
<tr>
237+
<td align="center" style="word-wrap: break-word; width: 150.0; height: 150.0">
238+
<a href="https://github.com/baxyz">
239+
<img src="https://avatars.githubusercontent.com/u/7852177?v=4" width="100;" alt="Bérenger"/>
240+
<br />
241+
<sub style="font-size:14px"><b>Bérenger</b></sub>
242+
</a>
243+
</td>
244+
</tr>
245+
</table>

0 commit comments

Comments
 (0)