Update README.md

README.md

@@ -1,3 +1,30 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+---
+# Dataset Summary
+
+KStack is the bigest collection of permissvly licesed Kotlin code.
+
+# Dataset Creation
+
+## Collection procedure
+
+We collected repositories from GitHub with the main language being Kotlin, as well as repositories with Kotlin files that have received 10 or more stars (as of February 2024). Additionally, we gathered repositories with Kotlin files from Stack v1.2. Kotlin files were identified using go-enry, and include files with extensions such as .kt, .kts, and .gradle.kts. It is estimated that we have collected 97% of available Kotlin repositories as of February 2024.
+
+## Initial filtering
+We conducted full deduplication, using the hash of file content, as well as near deduplication using the same method as in Stack v1.2. We then aggregated the files from one near-deduplicated cluster into a single file from that cluster.
+
+## Detecting permissive licenses
+We filtered permissive repositories based on the licenses detected by GitHub, and using go-license-detector if GitHub did not have license information available. 
+The list of permissive licenses used in dataset could be found here.
+
+## Personal and Sensitive Information
+We used star-pii model to filter out personal info.
+
+## Opt-out
+If you want your data to be removed from dataset, or have any other questions, please reach out to Sergey Titov<sergey.titov@jetbrains.com>
+
+
+# Comparison with the Stack
+
+WIP