From bb80afbf8ea6f537da05a534dbe5452ab3500ed8 Mon Sep 17 00:00:00 2001
From: Nanten <nanten@nandina.net>
Date: Thu, 20 Feb 2025 14:42:55 +0900
Subject: [PATCH] Add readme

---
 readme.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..96d88ef
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,18 @@
+# typora-img-uploader-r2
+
+Upload images to R2 using Typora.
+
+``` bash:.env
+.env
+
+R2_ENDPOINT = 'https://your-endpoint-url'
+R2_BUCKET_NAME= 'bucket name'
+R2_ACCESS_KEY_ID = 'access key'
+R2_SECRET_ACCESS_KEY = 'securet access key'
+R2_CUSTOM_URL = 'https://custom.domain/'
+```
+
+## Usage
+```python
+upload.py --image-path <image path>
+```
\ No newline at end of file