Skip to content

Commit

Permalink
Update Readme.md to comply with standards (#23)
Browse files Browse the repository at this point in the history
Signed-off-by: Alfredo Gutierrez <[email protected]>
  • Loading branch information
AlfredoG87 authored Dec 21, 2023
1 parent 4db37e2 commit 882851c
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/charts.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
uses: actions/checkout@v3

- name: Install ct
uses: helm/chart-testing-action@v2.4.0
uses: helm/chart-testing-action@v2.6.1

- name: Run lint
run: ct lint --config .github/ct.yaml --all
Expand All @@ -39,7 +39,7 @@ jobs:
uses: docker/setup-qemu-action@v2

- name: Install ct
uses: helm/chart-testing-action@v2.4.0
uses: helm/chart-testing-action@v2.6.1

- name: Install chart
run: ct install --helm-extra-args="--timeout 10m" --charts charts/hedera-the-graph --config .github/ct.yaml
Expand Down
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,39 @@
# hedera-the-graph
Tools for hosting a graph node for the Hedera community.

### hedera-the-graph helm chart
This project contains an umbrella helm charts that can be used to deploy an Hedera optimized graph node to a Kubernetes cluster with all the necessary architecture and configuration.
For more information see the [Hedera-The-Graph Chart Documentation](https://github.com/hashgraph/hedera-the-graph/tree/main/charts/hedera-the-graph)

## Release

This repo follows a git feature branch flow off of main.
All features should see a feature branch created and a PR taking the changes from the feature branch and applying it to main or the appropriate relese branch.

Periodically, release branches e.g. `release/0.1` will be created.

## Support

If you have a question on how to use the product, please see our
[support guide](https://github.com/hashgraph/.github/blob/main/SUPPORT.md).

## Contributing

Contributions are welcome. Please see the
[contributing guide](https://github.com/hashgraph/.github/blob/main/CONTRIBUTING.md)
to see how you can get involved.

## Code of Conduct

This project is governed by the
[Contributor Covenant Code of Conduct](https://github.com/hashgraph/.github/blob/main/CODE_OF_CONDUCT.md). By
participating, you are expected to uphold this code of conduct. Please report unacceptable behavior
to [[email protected]](mailto:[email protected]).

## License

[Apache License 2.0](LICENSE)

# 🔐 Security

Please do not file a public ticket mentioning the vulnerability. Refer to the security policy defined in the [SECURITY.md](https://github.com/hashgraph/hedera-sourcify/blob/main/SECURITY.md).

0 comments on commit 882851c

Please sign in to comment.