Skip to content

Commit a75171b

Browse files
committed
Update README
1 parent e9539b8 commit a75171b

File tree

1 file changed

+11
-21
lines changed

1 file changed

+11
-21
lines changed

README.md

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,44 @@
1-
# daggerverse Helm Module
1+
# Daggerverse Helm Module
22

33
[Dagger](https://dagger.io/) module for [daggerverse](https://daggerverse.dev/) providing [Helm](https://helm.sh/) functionality.
44

55
The Dagger module is located in the [helm](./helm/) directory.
66

7-
## usage
7+
## Usage
88

99
Basic usage guide.
1010

1111
The [helm](./helm/) directory contains a [daggerverse](https://daggerverse.dev/) [Dagger](https://dagger.io/) module.
1212

13-
Check the official Dagger Module documentation: https://docs.dagger.io/zenith/
13+
Check the official Dagger Module documentation: https://docs.dagger.io/api/module-structure
1414

1515
The [Dagger CLI](https://docs.dagger.io/cli) is needed.
1616

17-
### functions
17+
### Functions
1818

1919
List all functions of the module. This command is provided by the [Dagger CLI](https://docs.dagger.io/cli).
2020

2121
```bash
2222
dagger functions -m ./helm/
2323
```
2424

25-
The helm module is referenced locally.
26-
27-
See the module [readme](./helm/README.md) or the method comments for more details.
28-
29-
## development
25+
## Development
3026

3127
Basic development guide.
3228

33-
### setup Dagger module
34-
35-
Setup the Dagger module.
36-
37-
Create the directory for the module and initialize it.
29+
### Setup Dagger module
3830

3931
```bash
40-
mkdir helm/
41-
cd helm/
42-
43-
# initialize Dagger module
44-
dagger init
45-
dagger develop --sdk go --source helm
32+
dagger develop --source helm
4633
```
4734

35+
## Contributors
36+
37+
Please add `gofmt -s -w .` to your `.git/hooks/pre-commit` hook.
38+
4839
## To Do
4940

5041
- [ ] Add more tools
5142
- [ ] Add cache mounts
5243
- [ ] Add environment variables
5344
- [ ] Add more examples
54-
- [ ] Add tests

0 commit comments

Comments
 (0)