From 2bf8f0b937b6f2a2cdad9fb7389f2fd185c7e4df Mon Sep 17 00:00:00 2001
From: Zack Spear <hi@zackspear.com>
Date: Tue, 30 Apr 2024 17:33:16 -0700
Subject: [PATCH] fix(api): readme discord url

---
 api/README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 api/README.md

diff --git a/api/README.md b/api/README.md
new file mode 100644
index 000000000..76ae5b6d3
--- /dev/null
+++ b/api/README.md
@@ -0,0 +1,58 @@
+# @unraid/api
+
+## Installation
+
+Install the production plugin via the apps tab (search for "my servers") on Unraid 6.9.2 or later.
+
+## CLI
+
+If you're on a unraid v6.9.2 or later machine this should be available by running `unraid-api` in any directory.
+
+```bash
+root@Devon:~# unraid-api
+
+Unraid API
+
+  Thanks for using the official Unraid API 
+
+Usage:
+
+  $ unraid-api command <options> 
+
+Commands:
+
+  start/stop/restart/version/status/report/switch-env
+
+Options:
+
+  -h, --help                                                   Prints this usage guide.     
+  -d, --debug                                                  Enabled debug mode.          
+  -p, --port string                                            Set the graphql port.        
+  --environment production/staging/development                 Set the working environment. 
+  --log-level ALL/TRACE/DEBUG/INFO/WARN/ERROR/FATAL/MARK/OFF   Set the log level.           
+
+  Copyright © 2022 Lime Technology, Inc.
+
+```
+
+## Report
+To view the current status of the unraid-api and its connection to mothership, run:
+```
+unraid-api report
+```
+
+To view verbose data (anonymized), run:
+```
+unraid-api report -v
+```
+
+To view non-anonymized verbose data, run:
+```
+unraid-api report -vv
+```
+
+## Secrets
+If you found this file you're likely a developer. If you'd like to know more about the API and when it's available please join [our discord](https://discord.unraid.net/).
+
+## License
+Copyright 2019-2022 Lime Technology Inc. All rights reserved.