From 3c9e1bc41bba92f6a81ae9000fa730820a5fda60 Mon Sep 17 00:00:00 2001
From: Jeremiah Russell <jerry@jrussell.ie>
Date: Mon, 29 Sep 2025 16:48:52 +0100
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs(lib):=20add=20documentation?=
 =?UTF-8?q?=20for=20cull-gmail=20library?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- create initial documentation file for cull-gmail library
- include installation instructions and usage steps
---
 docs/lib.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 docs/lib.md

diff --git a/docs/lib.md b/docs/lib.md
new file mode 100644
index 0000000..19ca3a4
--- /dev/null
+++ b/docs/lib.md
@@ -0,0 +1,23 @@
+## cull-gmail Library Documentation
+
+The `cull-gmail` library provides types to enable the culling of emails using the Gmail API including the following steps:
+- login to get authorization
+- backup the mailbox 
+- filtered lists of the contents
+- move email matching a filtered list to trash
+
+### Installation
+
+Add the library to your program's `Cargo.toml` using `cargo add`:
+
+```bash
+$ cargo add cull-gmail
+```
+
+Or by configuring the dependencies manually in `Cargo.toml`:
+
+```toml
+[dependencies]
+cull-gmail = "0.1.0"
+```
+