From 38d1bc46c8ecac4f562e9c3366c5ee5b6e085321 Mon Sep 17 00:00:00 2001
From: shima11 <shima.jin@icloud.com>
Date: Sat, 24 Feb 2024 16:48:47 +0900
Subject: [PATCH] update

---
 Package.swift |  3 ++-
 README.md     | 47 ++++++++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 48 insertions(+), 2 deletions(-)

diff --git a/Package.swift b/Package.swift
index 1336a60..21894d0 100644
--- a/Package.swift
+++ b/Package.swift
@@ -6,7 +6,8 @@ import PackageDescription
 let package = Package(
   name: "SkinSmoothingFilter",
   platforms: [
-    .iOS(.v15)
+    .iOS(.v15),
+    .macOS(.v11),
   ],
   products: [
     .library(
diff --git a/README.md b/README.md
index add9178..ccbc6bd 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,46 @@
-# SkinSmoothingFilter
\ No newline at end of file
+# SkinSmoothingFilter
+
+A lightweight SkinSmoothing Filter using Metal and CoreImage.
+
+
+# Requirements
+
+iOS 15+, macOS 11+
+
+# Installation
+
+You can add SkinSmoothingFilter to your project via Swift Package Manager by adding the following to your `Package.swift` file:
+
+```swift
+dependencies: [
+    .package(url: "https://github.com/shima11/SkinSmoothingFilter.git", .upToNextMajor(from: "1.0.0"))
+]
+```
+
+# Usage
+
+To use the SkinSmoothingFilter, you first need to import the package into your project:
+
+```swift
+import SkinSmoothingFilter
+```
+
+Then, create an instance of SkinSmoothingFilter, set your desired parameters, and process your images like so:
+
+```swift
+let filter = SkinSmoothingFilter()
+filter.inputImage = ciImage // Your input CIImage
+filter.inputAmount = inputAmount // Smoothing amount
+filter.inputSharpness = inputSharpness // Image sharpness
+filter.inputRadius = inputRadius // Blur radius
+
+let result = filter.outputImage // Processed CIImage
+```
+
+# Contributing
+
+Contributions are welcome! Please feel free to submit a pull request or open an issue if you have any ideas, bug reports, or suggestions.
+
+# License
+
+SkinSmoothingFilter is available under the MIT license. See the LICENSE file for more info.