Update README.md

README.md

@@ -1,3 +1,98 @@
----
-license: mit
----
+# SEC Exhibit 10 Material Contracts Dataset (2001-2024)
+
+## Overview
+
+This dataset contains material contracts (Exhibit 10) from SEC filings between 2001 and 2024, representing the largest collection of commercial contracts to date. It includes both original filings and text-converted versions.
+
+If you find this dataset useful, please cite to:
+
+Arbel, Yonathan A., *The Readability of Contracts: Big Data Analysis*, Forthcoming J. Empirical Legal Stud. 21:4 (Dec. 2024)
+
+Methodological information can be found in the paper cited above.
+
+For the latest version of the paper, please visit: https://papers.ssrn.com/sol3/papers.cfm?abstract_id=4962098
+
+## Main Dataset Files
+
+1. `SEC_Ex10_2001-2022_Original.zip` (~26 GB)
+   - Contains original Exhibit 10 filings from 2001 to 2022
+- Total files: 1,218,226
+- Files per year range from 44,190 (2019) to 79,291 (2005)
+
+2. `SEC_Ex10_2001-2024_txt.zip` (~20 GB)
+   - Contains text-converted Exhibit 10 filings from 2001 to 2024
+- Total files: 1,287,933
+- Files per year range from 19,819 (2024, partial year) to 79,349 (2005)
+
+These CSV files describe the internal structure of the main ZIP files:
+
+3. `SEC_Ex10_2001-2022_Original_structure.csv` (~76 MB)
+   - Describes the file structure inside `SEC_Ex10_2001-2022_Original.zip`
+
+4. `SEC_Ex10_2001-2024_txt_structure.csv` (~117 MB)
+   - Describes the file structure inside `SEC_Ex10_2001-2024_txt.zip`
+
+These structure description files provide detailed information about the contents of each ZIP file, including file names, paths, and potentially other metadata. While not crucial for basic usage, they can be helpful for users who need a more in-depth understanding of the dataset's organization without extracting the large ZIP files.
+
+## Usage Instructions
+
+1. Download the desired ZIP file(s).
+2. Extract the contents, maintaining the folder structure.
+3. Navigate to the year of interest.
+4. Access individual contract files as needed.
+
+## License and Attribution
+
+This dataset is derived from public SEC filings. When using this dataset, please:
+
+1. Cite the original SEC source: U.S. Securities and Exchange Commission (SEC) EDGAR database.
+2. Cite this dataset as follows:
+
+   Arbel, Yonathan A., *The Readability of Contracts: Big Data Analysis*, Forthcoming J. Empirical Legal Stud. 21:4 (Dec. 2024)
+
+3. Comply with SEC's terms of use and any applicable copyright laws.
+
+## Disclaimers
+
+- This dataset is provided for research and informational purposes only.
+- While efforts have been made to ensure accuracy, users should verify critical information against original SEC filings.
+- Some documents may contain sensitive business information. Use responsibly and ethically.
+
+## Data Processing
+
+The text files have been converted from their original formats for easier analysis. Users should be aware that this conversion process may have introduced minor discrepancies from the original filings.
+
+
+## Contributing
+
+If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
+
+## Contact
+
+For questions or further information about this dataset, please contact [Your Contact Information].
+
+## MIT License
+
+Copyright (c) 2024 Yonathan A. Arbel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+Remember to use this dataset responsibly and in compliance with all applicable laws and regulations.