Skip to content

Commit 5066f3f

Browse files
authored
Update README.md
1 parent 913c033 commit 5066f3f

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
# SysFlow Documentation
21
[![Documentation Status](https://readthedocs.org/projects/sysflow/badge/?version=latest)](https://sysflow.readthedocs.io/en/latest/?badge=latest)
32

4-
This repository aggregates the [documentation](https://sysflow.readthedocs.io/) from the different SysFlow projects and hosts SysFlow's [issue tracker](https://github.com/sysflow-telemetry/sf-docs/issues).
3+
# SysFlow: Cloud-native system telemetry pipeline
4+
5+
This repository hosts the [documentation](https://sysflow.readthedocs.io/) and [issue tracker](https://github.com/sysflow-telemetry/sf-docs/issues) for all SysFlow projects.
56

67
# Quick reference
78

@@ -16,6 +17,9 @@ This repository aggregates the [documentation](https://sysflow.readthedocs.io/)
1617

1718
- **Source of this description**:
1819
[repo's readme](https://github.com/sysflow-telemetry/sysflow/edit/master/README.md) ([history](https://github.com/sysflow-telemetry/sysflow/commits/master))
20+
21+
- **Docker images**:
22+
[docker hub](https://hub.docker.com/u/sysflowtelemetry) | [GHCR](https://github.com/orgs/sysflow-telemetry/packages)
1923

2024
# What is SysFlow?
2125

@@ -43,3 +47,11 @@ To build the site as HTML go to the base directory and type:
4347
```
4448
make html
4549
```
50+
51+
# License
52+
53+
View [license information](https://github.com/sysflow-telemetry/sysflow/blob/master/LICENSE.md) for SysFlow.
54+
55+
As with all software packages, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).
56+
57+
As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

0 commit comments

Comments
 (0)