From dd82b5bf67278ddd1bfbe206421171c324b67041 Mon Sep 17 00:00:00 2001
From: PorridgePi <kunbao2006@126.com>
Date: Sun, 8 Oct 2023 02:51:31 +0800
Subject: [PATCH] feat: add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d635553
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# DoH MobileConfig
+
+Generates DoH (DNS-over-HTTPS) mobileconfig for iOS 14.0 or later and macOS 11.0 Big Sur or later
+
+## Requirements
+- Python 3
+- Python Packages
+  - `httpx`
+  - `dnspython`
+
+## Getting Started
+- Install Requirements: `pip3 install httpx dnspython`
+- For a demonstration using the sample configuration file, run: `python3 doh-mobileconfig.py -c config-sample.yaml`
+- Copy `config-sample.yaml` to `config.yaml`: `cp config-sample.yaml config.yaml`
+- Edit `config.yaml`
+- Run: `python3 doh-mobileconfig.py`
+
+## Usage
+
+```
+python3 doh-mobileconfig.py -h                                                                                     ✔
+usage: doh-mobileconfig.py [-h] [-p] [--suffix SUFFIX] [-c CONFIG]
+
+options:
+  -h, --help            show this help message and exit
+  -p, --print           print formatted device information and URLs
+  --suffix SUFFIX       sets a suffix to device information, defaults to '-wan'
+  -c CONFIG, --config CONFIG
+                        specify custom location to config.yaml
+```