From ebdee84f2f8723204f6a84cdd517c88df002f307 Mon Sep 17 00:00:00 2001
From: narugo1992 <117186571+narugo1992@users.noreply.github.com>
Date: Thu, 28 Dec 2023 20:40:38 +0800
Subject: [PATCH] dev(narugo): add README

---
 .github/workflows/repack.yml |  2 +-
 README.md                    | 22 ++++++++++++++++++++++
 2 files changed, 23 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/repack.yml b/.github/workflows/repack.yml
index fb778e3..b93b457 100644
--- a/.github/workflows/repack.yml
+++ b/.github/workflows/repack.yml
@@ -2,7 +2,7 @@
 name: Repacker
 
 on:
-  push:
+  #  push:
   workflow_dispatch:
   schedule:
     - cron: '0 6,14,22 * * *'
diff --git a/README.md b/README.md
index a261820..8b49e8b 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,25 @@
 # skpick
 
 Picker for skpick, just bullshit
+
+Extract from one zip file
+
+```python
+from skpick.pick import pick_from_package
+
+pick_from_package(
+    '/your/package.zip',
+    '/your/directory/to/save',
+)
+```
+
+Extract from multiple zip file from a directory
+
+```python
+from skpick.pick import pick_from_dir_of_packages
+
+pick_from_dir_of_packages(
+    '/your/packages/dir',
+    '/your/directory/to/save',  # files from all the packages will be stored to this directory
+)
+```