From 182ba5f88d51e1b55f6257cc6578733651fe43cf Mon Sep 17 00:00:00 2001
From: Michael Litschauer <michael.litschauer@gmail.com>
Date: Tue, 18 Feb 2025 22:01:33 +0100
Subject: [PATCH] Update README.md

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++--
 1 file changed, 38 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 7985e74..2c67665 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,38 @@
-# database
-Content of the GenderComics database.
+# GenderComics Database
+
+This repository contains JSON files exported from the MongoDB collections of the GenderComics database. The data encapsulated within these files represents various aspects of the GenderComics project. 
+
+## Repository Structure
+
+The repository is organized as follows:
+
+- `json/`: This directory contains all the JSON files exported from the MongoDB collections. Each JSON file corresponds to a specific collection from the GenderComics database.
+
+## Usage
+
+To use the data in this repository:
+
+1. **Clone the repository**:
+    ```bash
+    git clone https://github.com/gendercomics/database.git
+    cd database
+    ```
+
+2. **Import JSON files into MongoDB**:
+    You can import the JSON files into your MongoDB instance using the `mongoimport` tool. For example:
+    ```bash
+    mongoimport --db gendercomics --collection <collection-name> --file json/<file-name>.json --jsonArray
+    ```
+    Replace `<collection-name>` with the name of the collection you want to import and `<file-name>` with the respective JSON file name.
+
+## Contributing
+
+We welcome contributions to improve the data quality and structure. If you have any suggestions or improvements, please open an issue or submit a pull request.
+
+## License
+
+TODO
+
+## Contact
+
+For any questions or concerns, please reach out to the maintainers of the project.
-- 
GitLab