Skip to content

Commit

Permalink
Improve project README
Browse files Browse the repository at this point in the history
Problem:
Project README is empty

Solution:
Add content to project README.
  • Loading branch information
pleshakov committed Feb 29, 2024
1 parent 3fc010d commit 6cc0c8c
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,26 @@
# telemetry-exporter
# Telemetry Exporter

This project is a library that exports product telemetry data to an F5-managed service.

It is used by [NGINX Ingress Controller](https://github.com/nginxinc/kubernetes-ingress)
and [NGINX Gateway Fabric](https://github.com/nginxinc/nginx-gateway-fabric) projects.

## Contacts

If you experience issues with this project, please [open a bug][bug] in
GitHub. If you have any suggestions or feature requests, please [open an idea][idea] on GitHub discussions.

You can contact us directly via kubernetes@nginx.com or on the [NGINX Community Slack][slack] in
the `#kubernetes` channel.

[bug]: https://github.com/nginxinc/telemetry-exporter/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=
[idea]: https://github.com/nginxinc/telemetry-exporter/discussions/categories/ideas
[slack]: https://nginxcommunity.slack.com/channels/kubernetes

## Contributing

Please read our [Contributing guide](CONTRIBUTING.md) if you'd like to contribute to the project.

## Support

This project is not covered by any support contract.

0 comments on commit 6cc0c8c

Please sign in to comment.