Update README.md

README.md

@@ -1,3 +1,71 @@
+# CaraArchive Index Dataset
+
+### 1) This is an Index Dataset, not an Image dataset
+- This dataset contains **0 image data**.
+- It only contains links to Cara App's CDN and metadata.
+- HuggingFace may load some images in the preview because it detects the CDN links, however those images do not exist as data in this dataset, HF literally just loads them using your own connection as a preview.
+
+### 2) This dataset is *100% Complete*
+- It includes **3.43 million posts** (and their thumbnails) from **790k users** to which belong **8.52 million artworks**, making a total of **~12 million image links**.
+- Every user and every post on the platform (from 14/6/26 and before) is included here.
+- Some people got the impression that not all of their posts are there because they searched their names in the CDN URLs, however *not all URLs include the name in them* (many use server timestamps and random hashes).
+
 ---
-license: mit
+
+### How to Query the Database `tool.py` (make sure catalog.db is in the directory)
+
+To see a clean summary overview of an account
+```bash
+python tool.py --user <username>
+```
+
+To see all artworks, software, metadata and creator for a specific post:
+```bash
+python tool.py --post <Post URL or ID>
+```
+
+To find the post and creator that an artwork belongs to:
+```bash
+python tool.py --art <CDN URL or filename>
+```
+
+---
+
+### Database Structure (`catalog.db`)
+
+The SQLite database contains 3 main tables:
+
+#### `master_artworks_12m` (8,522,366 rows)
+Contains all full-resolution master artwork uploads.
+- `id`: Unique image ID (`<post_id>_slide_<number>`)
+- `post_id`: Post ID this artwork belongs to
+- `author_slug`: Username of the creator
+- `slide_number`: Order in the multi-image gallery (1, 2, 3...)
+- `title`: Post title
+- `cdn_url`: Direct high-res CDN link
+- `width`: Image width in pixels
+- `height`: Image height in pixels
+- `created_at`: Upload timestamp
+
+#### `artworks` (3,431,475 rows)
+Contains all posts and cover thumbnails.
+- `post_id`: Unique post ID
+- `author_slug`: Username of the creator
+- `author_id`: User UUID
+- `cdn_url`: Cover image / thumbnail link
+- `created_at`: Creation timestamp
+
+#### `post_metadata` (3,431,475 rows)
+Contains all tags, software, descriptions, and audit statuses.
+- `post_id`: Post ID
+- `author_slug`: Username
+- `author_name`: Display name
+- `title`: Post title
+- `content`: Description / lore text
+- `softwares`: Software used (e.g. `["Blender", "Photoshop"]`)
+- `tags`: Categories and tags (e.g. `["Illustration", "ConceptArt"]`)
+- `status_code`: HTTP status (`200` = active, `404` = deleted post, `403` = private)
+- `is_deleted`: `1` if post was removed, `0` if active
+- `created_at`: Creation timestamp
+
 ---