From 5efcdd2551e62a63aff8aa690da22c60c2632ed4 Mon Sep 17 00:00:00 2001
From: Romanoidz <78933901+Romanoidz@users.noreply.github.com>
Date: Thu, 17 Feb 2022 00:16:42 +0300
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c20a303
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# WireGuard installer
+
+![Lint](https://github.com/angristan/wireguard-install/workflows/Lint/badge.svg)
+![visitors](https://visitor-badge.glitch.me/badge?page_id=angristan.wireguard-install)
+[![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/angristan)
+
+**Этот скрипт представляет собой сценарий bash, целью которого является настройка [WireGuard](https://www.wireguard.com /) VPN на сервере Linux, как можно проще!**
+
+WireGuard - это point-to-point VPN, который можно использовать по-разному. Здесь мы имеем в виду VPN, как в: клиент будет пересылать весь свой трафик через зашифрованный туннель на сервер.
+Сервер применит NAT к трафику клиента, чтобы он выглядел так, как будто клиент просматривает веб-страницы с IP-адреса сервера.
+
+Скрипт поддерживает как IPv4, так и IPv6. Пожалуйста, проверьте [issues](https://github.com/angristan/wireguard-install/issues) для текущей разработки, ошибок и запланированных функций!
+
+WireGuard не подходит для вашей среды? Попробуйте [openvpn-install](https://github.com/angristan/openvpn-install).
+
+## Требования
+
+Поддерживаемые дистрибутивы:
+
+- Ubuntu >= 16.04
+- Debian >= 10
+- Fedora
+- CentOS
+- Arch Linux
+- Oracle Linux
+
+## Использование
+Загрузите и запустите скрипт. Ответьте на вопросы, заданные сценарием, и он позаботится обо всем остальном.
+
+```bash
+curl -O https://raw.githubusercontent.com/Romanoidz/wireguard-install/master/wireguard-install.sh
+chmod +x wireguard-install.sh
+./wireguard-install.sh
+```
+или 
+```bash
+wget https://raw.githubusercontent.com/Romanoidz/wireguard-install/master/wireguard-install.sh
+bash wireguard-install.sh
+```
+
+Он установит WireGuard (модуль ядра и инструменты) на сервер, настроит его, создаст службу systemd, файл конфигурации клиента и QR-код для быстрой настройки с мобильных устройств.
+
+Запустите скрипт еще раз, чтобы добавить или удалить клиентов!