Update README.md

README.md

@@ -47,3 +47,51 @@ configs:
   - split: test
     path: data/test-*
 ---
+
+# ArkTS Function Dataset
+
+**Dataset Hub:** [Your Dataset Link](https://huggingface.co/datasets/hreyulog/arkts-code-docstring/)
+
+This dataset collects **function-level information from ArkTS (HarmonyOS Ark TypeScript) projects**, including original functions, docstrings, abstract syntax tree (AST) representations, obfuscated versions, and source code metadata. It is suitable for tasks such as code analysis, code understanding, AST research, and code search.
+
+## Dataset Structure
+
+The dataset contains three splits:
+
+- `train`: Training set
+- `validation`: Validation set
+- `test`: Test set
+
+Each split is a **JSON Lines (.jsonl) file**, where each line is a JSON object representing a single function.
+
+## Features / Columns
+
+| Field | Type | Description |
+|-------|------|------------|
+| `nwo` | string | Repository name |
+| `sha` | string | Commit SHA |
+| `path` | string | File path |
+| `language` | string | Programming language |
+| `identifier` | string | Function identifier / name |
+| `docstring` | string | Function docstring |
+| `function` | string | Original function source code |
+| `ast_function` | string | AST representation of the function |
+| `obf_function` | string | Obfuscated function source code |
+| `url` | string | URL to the code in the repository |
+| `function_sha` | string | Function-level SHA |
+| `source` | string | Code source (GitHub / Gitee) |
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+# Load the dataset
+dataset = load_dataset("USERNAME/DATASET_NAME")
+
+# Inspect the first training example
+print(dataset["train"][0])
+
+# Check dataset features
+print(dataset["train"].features)
+