object: Document

1 files changed, 14 insertions, 0 deletions

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