CLT library code structure

Author: maxgoffart

library/README.md

@@ -0,0 +1,15 @@
+# CLT Library
+
+This library allows to enable or disable CLT in the Linux kernel by using [generic netlink](https://docs.kernel.org/networking/generic_netlink.html) to interact with the kernel.
+
+## Usage
+
+The implementations **must** provide 2 methods:
+- One to **enable** CLT on a given socket with given trace and span IDs.
+- One to **disable** CLT on a given socket.
+
+## Existing implementations
+
+At the moment, implementations are available in the following languages:
+- [Python](./python/)
+- [Go](./golang/)

clt_genl_go/README.md library/golang/README.mdclt_genl_go/README.md renamed to library/golang/README.md

@@ -1,8 +1,6 @@
-# CLT Generic Netlink Go
+# CLT Library in Go
 
-This module allows to enable or disable CLT in the Linux kernel from software in Go.
-
-It is an equivalent of [clt_genl.py](../clt_genl.py), which is written in Python.
+Implementation in Go of the library to enable or disable CLT.
 
 ## Usage
 

clt_genl_go/clt_genl.go library/golang/clt_genl.goclt_genl_go/clt_genl.go renamed to library/golang/clt_genl.go

@@ -0,0 +1,26 @@
+# CLT Library in Python
+
+Implementation in Python of the library to enable or disable CLT.
+
+## Usage
+
+First, you need to download the dependency with the following command:
+```bash
+pip3 install pyroute2
+```
+
+Then, you need to create an instance of the class `CrossLayerTelemetry`.
+
+Now, you can enable CLT on a socket by calling the method:
+```python
+def enable(self, sockfd, traceId, spanId)
+```
+
+Finally, when you want to disable CLT, you can call the method:
+```python
+def disable(self, sockfd)
+```
+
+## Credits
+
+To use (generic) netlink in Python, we use the package [pyroute2](https://pypi.org/project/pyroute2/) by [Peter Saveliev](https://github.com/svinota).