From cbbf6ad1bfa9b19c9963258976ace48b6bfb608d Mon Sep 17 00:00:00 2001
From: Shibo Lyu <github@of.sb>
Date: Mon, 24 Jul 2023 11:50:05 +0800
Subject: [PATCH] docs: Update README.

---
 .spi.yml  | 5 +++++
 README.md | 8 +++++++-
 2 files changed, 12 insertions(+), 1 deletion(-)
 create mode 100644 .spi.yml

diff --git a/.spi.yml b/.spi.yml
new file mode 100644
index 0000000..42a3823
--- /dev/null
+++ b/.spi.yml
@@ -0,0 +1,5 @@
+version: 1
+builder:
+  configs:
+    - documentation_targets: [CropImage]
+
diff --git a/README.md b/README.md
index c3436c1..d67383c 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,9 @@
 # CropImage
 
-A description of this package.
+A simple SwiftUI view where user can move and resize an image to a pre-defined size.
+
+Supports iOS 14.0 and above, or macOS Ventura 13.0 and above.
+
+- Supports both iOS and macOS
+- Use `ImageRenderer` to render the cropped image, when possible
+- Very lightweight