Browse Source

updating docs with images

afeiszli 3 years ago
parent
commit
eb70387edb
1 changed files with 7 additions and 11 deletions
  1. 7 11
      README.md

+ 7 - 11
README.md

@@ -29,9 +29,8 @@
 
 # WireGuard® Automation from Homelab to Enterprise
 - [x] Peer-to-Peer Mesh Networks
-- [x] Site-to-Site Gateways
-- [x] Private DNS
 - [x] Kubernetes Multi-Cloud
+- [x] Private DNS
 - [x] Linux, Mac, Windows, iPhone, and Android
 
 # Get Started in 5 Minutes
@@ -44,23 +43,21 @@
 
 `sudo wget -qO - https://raw.githubusercontent.com/gravitl/netmaker/develop/scripts/nm-quick.sh | bash`
 
-Upon completion, the logs will display a script that can be used to automatically connect Linux and Mac devices.
-
-It will also display instructions for Windows, iPhone, and Android.
+Upon completion, the logs will display a script that can be used to automatically connect Linux and Mac devices. It will also display instructions for Windows, iPhone, and Android.
 
 <img src="./docs/images/install-server.gif" width="50%" /><img src="./docs/images/visit-website.gif" width="50%" />
 
-After installing Netmaker, check out the [Walkthrough](https://itnext.io/getting-started-with-netmaker-a-wireguard-virtual-networking-platform-3d563fbd87f0) and [Getting Started](https://netmaker.readthedocs.io/en/ma(ster/getting-started.html) guide to begin setting up networks. Or, check out some of our other [Tutorials](https://gravitl.com/resources) for different use cases, including Kubernetes.
+After installing Netmaker, check out the [Walkthrough](https://itnext.io/getting-started-with-netmaker-a-wireguard-virtual-networking-platform-3d563fbd87f0) and [Getting Started](https://netmaker.readthedocs.io/en/master/getting-started.html) guides to learn more about configuring networks. Or, check out some of our other [Tutorials](https://gravitl.com/resources) for different use cases, including Kubernetes.
 
 ### Optional configurations
 
 **Deploy a "Hub-And-Spoke VPN" on the server**  
-a. This will configure a standard VPN (non-meshed) for private internet access, with 10 clients (-c).  
-b. `sudo wget -qO - https://raw.githubusercontent.com/gravitl/netmaker/develop/scripts/nm-quick.sh | bash -s -- -v true -c 7`  
+*This will configure a standard VPN (non-meshed) for private internet access, with 10 clients (-c).*  
+`sudo wget -qO - https://raw.githubusercontent.com/gravitl/netmaker/develop/scripts/nm-quick.sh | bash -s -- -v true -c 7`  
 
 **Specify Domain sand Email**  
-a. Make sure your wildcard domain is pointing towards the server ip.  
-b. `sudo wget -qO - https://raw.githubusercontent.com/gravitl/netmaker/develop/scripts/nm-quick.sh | bash -s -- -d mynetmaker.domain.com -e [email protected]`  
+*Make sure your wildcard domain is pointing towards the server ip.*  
+`sudo wget -qO - https://raw.githubusercontent.com/gravitl/netmaker/develop/scripts/nm-quick.sh | bash -s -- -d mynetmaker.domain.com -e [email protected]`  
 
 **Script Options**  
 ```
@@ -72,7 +69,6 @@ b. `sudo wget -qO - https://raw.githubusercontent.com/gravitl/netmaker/develop/s
 -c 7 # number of client configs to create (for VPN network, 5 by default)
 ```
 
-
 # Why Netmaker + WireGuard?
 
 - Netmaker automates virtual networks between data centers, clouds, and edge devices, so you don't have to.