From 0023d95f5db8f8c63db9098623df76512cb4c337 Mon Sep 17 00:00:00 2001
From: Runxi Yu
Date: Thu, 2 Apr 2026 07:19:57 +0000
Subject: object: Document

---
 object/doc.go | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 object/doc.go

(limited to 'object/doc.go')

diff --git a/object/doc.go b/object/doc.go
new file mode 100644
index 00000000..4566ae48
--- /dev/null
+++ b/object/doc.go
@@ -0,0 +1,14 @@
+// Package object provides the shared [Object] interface
+// and parsing functions for Git object values.
+//
+// Concrete object forms such as
+// [blob], [tree], [commit], and [tag]
+// live in subpackages.
+// Use [codeberg.org/lindenii/furgit/object/stored] when object values
+// need to be paired with the object IDs
+// they were loaded under.
+//
+// This package also encapsulates other object-related packages,
+// including but not limited to
+// object IDs, object types, and object stores.
+package object
-- 
cgit v1.3.1-10-gc9f91