Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore] Update README.md #83

Merged
merged 1 commit into from
Jan 4, 2025
Merged

[chore] Update README.md #83

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ To install the Meshery Snapshot Helm Plugin, use the following steps:
Once the plugin is installed, you can generate a snapshot using either a packaged or unpackaged Helm chart.

```bash
helm snapshot -f <chart-URI> [-n <snapshot-name>] [-e <email>]
helm helm-kanvas-snapshot -f <chart-URI> [-n <snapshot-name>] [-e <email>]
```

- **`-f`**, **`--file`**: (required) path or URL to the Helm chart (required).
Expand All @@ -84,7 +84,7 @@ helm snapshot -f <chart-URI> [-n <snapshot-name>] [-e <email>]
To generate a snapshot for a Helm chart located at `https://meshery.io/charts/v0.8.0-meshery.tar.gz`, you can use:

```bash
helm snapshot -f https://meshery.io/charts/v0.8.0-meshery.tar.gz -n meshery-chart
helm helm-kanvas-snapshot -f https://meshery.io/charts/v0.8.0-meshery.tar.gz -n meshery-chart
```

## Contributing
Expand Down Expand Up @@ -128,7 +128,7 @@ helm plugin install kanvas-snapshot
Once the plugin is built, you can test it locally. For example, to generate a snapshot for a Helm chart, run the following command:

```bash
helm kanvas-snapshot -f https://meshery.io/charts/v0.8.0-meshery.tar.gz -n meshery-chart
helm helm-kanvas-snapshot -f https://meshery.io/charts/v0.8.0-meshery.tar.gz -n meshery-chart
```

This command will trigger the snapshot generation process. If everything is set up correctly, you should see a visual snapshot URL or receive the snapshot via email, depending on the options you specified.
Expand Down