From d320231752d0b2d3593582806a9fb6a8470bc8d1 Mon Sep 17 00:00:00 2001
From: Vincent Young <missuo@pm.me>
Date: Thu, 20 Oct 2022 02:11:14 +0800
Subject: [PATCH] Update README.md

---
 README.md              | 43 +++++++++++++++++++++++++++++++++++++++++-
 me.missuo.deeplx.plist | 20 ++++++++++++++++++++
 2 files changed, 62 insertions(+), 1 deletion(-)
 create mode 100644 me.missuo.deeplx.plist

diff --git a/README.md b/README.md
index 206781d..c83d6bf 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,42 @@
-# deepl-api
\ No newline at end of file
+<!--
+ * @Author: Vincent Young
+ * @Date: 2022-10-18 07:32:29
+ * @LastEditors: Vincent Young
+ * @LastEditTime: 2022-10-20 02:10:43
+ * @FilePath: /deepl-api/README.md
+ * @Telegram: https://t.me/missuo
+ * 
+ * Copyright © 2022 by Vincent, All Rights Reserved. 
+-->
+# DeepLX
+Permanently free DeepL API written in Go
+
+## Run on Mac
+1. Download  the latest release of DeepLX.
+```bash
+sudo mv deeplx_darwin_amd64 /usr/local/bin/deeplx
+```
+
+2. Download the `me.missuo.deeplx.plist` to `/Users/vincent/Library/LaunchAgents`.
+```bash
+wget https://raw.githubusercontent.com/OwO-Network/DeepLX/main/me.missuo.deeplx.plist -O /Users/vincent/Library/LaunchAgents/me.missuo.deeplx.plist
+```
+3. Run following command.
+```bash
+launchctl load /Library/LaunchAgents/me.missuo.deeplx.plist
+launchctl start /Library/LaunchAgents/me.missuo.deeplx.plist
+```
+
+## Setup on [Bob App](https://bobtranslate.com/)
+1. Install [bob-plugin-deeplx](https://github.com/clubxdev/bob-plugin-deeplx) on Bob.
+
+2. Setup the API.
+![9a75c26ad6e8bd9b7582c](https://missuo.ru/file/9a75c26ad6e8bd9b7582c.png)
+
+## Contributors
+- [Leo Shen](https://github.com/sjlleo)
+- [Vincent Young](https://github.com/missuo)
+
+## License
+MIT License
+
diff --git a/me.missuo.deeplx.plist b/me.missuo.deeplx.plist
new file mode 100644
index 0000000..055115f
--- /dev/null
+++ b/me.missuo.deeplx.plist
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>Label</key>
+	<string>me.missuo.deeplx</string>
+	<key>KeepAlive</key>
+	<true/>
+	<key>ProgramArguments</key>
+	<array>
+		<string>/usr/local/bin/deeplx</string>
+	</array>
+	<key>RunAtLoad</key>
+	<true/>
+	<key>OnDemand</key>
+	<false/>
+	<key>LaunchOnlyOnce</key>
+	<true/>
+</dict>
+</plist>