Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jackspirou committed Nov 29, 2024
1 parent d5e1d50 commit 2b47daa
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
- Supports nested value structures (e.g., `{{ .Values.gateway.domain }}`)
- Handles default values in templates (e.g., `{{ .Values.domain | default "api.example.com" }}`)
- Creates missing values in values files with their default values
- Preserves existing values and structure in your values files
- Preserves existing values, structure, and data types in your values files
- Provides line number and source file tracking for each reference
- Uses atomic file operations to prevent data corruption
- Provides robust error handling with detailed messages
Expand Down Expand Up @@ -122,7 +122,7 @@ Running `shcv .` will create/update `values.yaml`:
name: "my-ingress"
domain: "example.com"
path: "/"
port: "80"
port: 80
```

## Requirements
Expand Down
2 changes: 1 addition & 1 deletion pkg/shcv/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Key features:
- Supports nested value structures
- Handles default values in templates
- Creates missing values with their default values
- Preserves existing values and structure
- Preserves existing values, structure, and data types \(e.g., numbers, strings\)
- Provides line number and source file tracking
- Uses atomic file operations
- Provides robust error handling
Expand Down
2 changes: 1 addition & 1 deletion pkg/shcv/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Key features:
- Supports nested value structures
- Handles default values in templates
- Creates missing values with their default values
- Preserves existing values and structure
- Preserves existing values, structure, and data types (e.g., numbers, strings)
- Provides line number and source file tracking
- Uses atomic file operations
- Provides robust error handling
Expand Down

0 comments on commit 2b47daa

Please sign in to comment.