Update README.md

README.md

@@ -1,7 +1,28 @@
-This dataset is used to store the raw data, that is crawled from github resources of projects that are in the CNCF landscape. It contains information that was stored im yaml, md and pdf files. The data format for the stored data is json.
 
----
-license: apache-2.0
-language:
-- en
----
+# CNCF Raw Data for LLM Training
+
+## Description
+This dataset, named `cncf-raw-data-for-llm-training`, consists of markdown (MD) and PDF content extracted from various project repositories within the CNCF (Cloud Native Computing Foundation) landscape. The data was collected by fetching MD and PDF files from different CNCF project repositories and converting them into JSON format. This dataset is intended as raw data for training large language models (LLMs).
+
+The dataset includes the following two columns:
+1. **Tag**: A JSON object that categorizes the file. For example:
+    ```json
+    {
+      "category": "Runtime",
+      "file_name": "log-attach-design.md",
+      "project_name": "rkt",
+      "subcategory": "Container Runtime"
+    }
+    ```
+   - **Category**: A broad classification representing the main functional area of the project.
+   - **File Name**: The name of the file as it appears in the original repository.
+   - **Project Name**: The name of the specific project to which the file belongs.
+   - **Subcategory**: A more specific classification within the main category.
+
+2. **Content**: The actual content of the file (MD or PDF) in Jason format.
+
+## License
+This dataset is available under the MIT license.
+
+## Links
+- [GitHub Repository](https://github.com/amosproj/amos2024ss08-cloud-native-llm)