[docs] Full pass thru docs, table of contents improvements, consistency and grammar fixes, added Altcoins.md

ch4ot1c · ch4ot1c · commit f1b665ca0991 · 2018-09-04T04:53:01.000-05:00
diff --git a/Altcoins.md b/Altcoins.md
@@ -0,0 +1,39 @@
+# Altcoins
+
+Support is implemented for several coins:
+
+* Litecoin
+* BGold
+* BCash
+* Dash
+* Dogecoin
+* Feathercoin
+* Groestlcoin
+* Monacoin
+* Polis
+* UFO
+* Viacoin
+
+## How can I add an altcoin to BTCPayServer?
+
+The steps for having a coin added are:
+
+1. Add support for your crypto to [NBitcoin](https://github.com/MetacoSA/NBitcoin/tree/master/NBitcoin.Altcoins), [NBxplorer](https://github.com/dgarage/NBXplorer), and [BTCPayServer](https://github.com/btcpayserver/btcpayserver). (Use examples from other coins)
+2. Create your own docker image ([Example for BTC](https://hub.docker.com/r/nicolasdorier/docker-bitcoin/))
+3. Create a docker-compose fragment ([Example for BTC](docker-compose-generator/docker-fragments/bitcoin.yml))
+4. Add your CryptoDefinition ([Example for BTC](docker-compose-generator/src/CryptoDefinition.cs))
+
+When testing your coin, **DO NOT USE `build.sh`**, since it uses a pre-built docker image.
+
+Instead, install [.NET Core 2.1 SDK](https://www.microsoft.com/net/download/windows) and run:
+
+```bash
+BTCPAYGEN_CRYPTO1="EXAMPLE-COIN"
+BTCPAYGEN_SUBNAME="test"
+cd docker-compose-generator/src
+dotnet run
+```
+
+This will generate your docker-compose in the `Generated` folder, which you can then run and test.
+
+Note that BTCPayServer developers will not spend excessive time testing your image, so make sure it works.
diff --git a/Architecture.md b/Architecture.md
@@ -1,41 +1,34 @@
-# How to deploy a BTCPay server instance
+# Architecture
 
-BTCPay Server is a project which ties together several applications into a coherent user experience for managing your own payment processor.
+BTCPayServer is a project which ties together several Bitcoin-related components into a coherent user experience for installing and managing your own payment processor.
 
-The minimal setup involve:
+![Architecture](img/Architecture.png)
+
+The minimal setup involves:
 
-* BTCPay Server
+* [BTCPayServer](https://github.com/btcpayserver/btcpayserver)
 * [NBXplorer](https://github.com/dgarage/NBXplorer) (Lightweight block explorer, responsible for tracking payments)
 * Bitcoin Core
-* (Optional) Postgres
+* (Optional) PostgreSQL
 
-By default, it uses SqlLite as database, but for production use, we advise you to use Postgres.
-
-![Architecture](img/Architecture.png)
+By default, it uses SqlLite, but all production deployments use Postgres.
 
-On top of this, if you need Lightning Network support, NBXplorer can support connection to:
+Additionally, if you need Lightning Network access, NBXplorer supports connections to:
 
-* C-Lightning instance via unix domain socket
+* C-Lightning (via unix sockets)
 * Lightning Charge
-* LND via the REST Proxy
+* LND (via the REST interface)
 
-If you want altcoin supports we support connection to the following full nodes:
+---
 
-* BGold
-* Dogecoin
-* Feathercoin
-* Groestlcoin
-* Litecoin
-* Monacoin
-* Polis
-* Viacoin
+We provide several ways of deploying BTCPayServer, depending on whether you favor flexibility or ease-of-use.
 
-Because BTCPay Server has lot's of dependencies, we provide different way of deploying depending if you favor flexibility or ease of use.
-From the hardest way to the easiest:
+From the easiest way to the hardest:
 
-* [Manual deployment](ManualDeployment.md) (Downloading, building and running all the dependencies by yourself)
-* [Docker deployment](DockerDeployment.md) (Using a `docker-compose.yml` file which bundle all the dependencies together)
 * [Azure deployment](AzureDeployment.md) (Using a one-click deploy on Microsoft Azure)
-* [Third party hosting](Managed.md) (Having someone else manage BTCPay for you)
+* [Docker deployment](DockerDeployment.md) (Using a `docker-compose.yml` file which bundle all the dependencies together, in almost any environment)
+* [Manual deployment](ManualDeployment.md) (Downloading, building and running all the dependencies by yourself)
+
+Some community members also offer [third-party hosting](ThirdPartyHosting.md) (Having someone else manage BTCPayServer for you).
 
-For people who wants to try BTCPay Server and does not require lightning network payment, and are not willing to host BTCPay by themselves, we advise you to see the list of third party on [The Ultimate List of BTCPay Server Hosts and Merchants](https://bitcoinshirt.co/btcpay-stores/).
+Remember the **huge value** of having **direct control** of your wallet and web service; for this reason we recommend you use [Azure deployment](AzureDeployment.md) and **do the setup yourself** - it is pretty easy!
diff --git a/ChangeDomain.md b/ChangeDomain.md
@@ -1,65 +1,61 @@
 # How to change the domain name of your BTCPay Server
 
-This article assume you know the following information:
+This article assumes you used either [Azure](https://github.com/btcpayserver/btcpayserver-azure) deployment or [BTCPay Docker](https://github.com/btcpayserver/btcpayserver-docker) deployment.
 
-* The SSH username and password of your server
-* That you used either [Azure](https://github.com/btcpayserver/btcpayserver-azure) deployment or [BTCPay Docker](https://github.com/btcpayserver/btcpayserver-docker) deployment.
-
-Let's assume I used `Azure` deployment, on which I get an invalid certificate:
+Let's assume I used Azure. After initially deploying, I get an invalid certificate (this is normal during setup):
 
 ![InvalidCertificate](img/InvalidCertificate.png)
 
 To get a valid certificate, I need to change my server address from `https://myawesomedemobtcpay.westeurope.cloudapp.azure.com/` to `https://tothemoon.btcpayserver.com/`.
 
-## Pre-requisite
+## Setting up your DNS record
 
-### Setting up your DNS record
-First I bought my domain name `btcpayserver.com` to a registar. (I use [gandi.net](https://gandi.net/) because they are awesome)
+First, I bought my domain name `btcpayserver.com` from a registar. (I use [gandi.net](https://gandi.net/) because they are awesome.)
 
 Once I got the domain name, I can access it in the `Domains` menu:
 
 ![Gandi1](img/Gandi1.png)
 
-So I click on my new domain `btcpayserver.com`, then go to the `DNS Record` menu, then I click `Add`.
+So I click on my new domain `btcpayserver.com`, then go to the `DNS Records` menu, then I click `Add`:
 
 ![Gandi2](img/Gandi2.png)
 
-Here I want to make sure `tothemoon.btcpayserver.com` will resolve to the same IP address as `myawesomedemobtcpay.westeurope.cloudapp.azure.com`. We call this a `CNAME record`:
+Here I want to make sure `tothemoon.btcpayserver.com` will resolve to the same IP address as `myawesomedemobtcpay.westeurope.cloudapp.azure.com`. We call this a `CNAME record`.
+
+So I fill out:
 
-So I fill out 
 ```
 Type: "CNAME", 
 Name: "tothemoon", 
-Hostname: "myawesomedemobtcpay.westeurope.cloudapp.azure.com." DO NOT FORGET THE '.'
+Hostname: "myawesomedemobtcpay.westeurope.cloudapp.azure.com." !! DO NOT FORGET THE '.' !!
 ```
-![Gandi3](img/Gandi3.png)
 
-Then I click `Create`. Note that if you want to point to an IP address instead, you would use a type `A` record.
-
-Congratulation! Now let's 
+![Gandi3](img/Gandi3.png)
 
-## From your BTCPay Server
+Then I click 'Create'. (Note that if you want to point directly to an IP address instead, you would use a type `A` record.)
 
-First, I go to `https://myawesomedemobtcpay.westeurope.cloudapp.azure.com/server/maintenance`.
-I must be logged as an administrator, which is typically the first account created on the server.
+**Congratulations! Now let's set it up on the other side, the BTCPayServer host.**
 
-I enter my SSH `Username` (by default on azure, `btcpayserver`) and `Password` I chose during the Azure Wizard setup.
+## From your browser
 
-Then I enter my domain name `tothemoon.btcpayserver.com`, and click confirm.
+* Visit `https://myawesomedemobtcpay.westeurope.cloudapp.azure.com/server/maintenance`
+* Log in as an administrator, which is typically the first account created on the server.
+* Enter new hostname `tothemoon.btcpayserver.com` and click 'Confirm'.
 
 ![Maintenance](img/Maintenance.png)
 
-I wait a bit and go to `https://tothemoon.btcpayserver.com/`, Success!
+I wait a bit and go to `https://tothemoon.btcpayserver.com` - Success!
 
 ![Maintenance2](img/Maintenance2.png)
 
-## From command line
+## From the command line
 
 I connect to my server via:
 
 ```bash
 ssh btcpayserver@myawesomedemobtcpay.westeurope.cloudapp.azure.com
 ```
+
 I enter the `Password` I chose during the Azure Wizard setup.
 
 ```bash
diff --git a/DockerDeployment.md b/DockerDeployment.md
@@ -1,9 +1,9 @@
-# Docker-Compose setup
+# Docker deployment
 
 [The minimal manual setup](ManualDeployment.md) is not good enough for production environment (no reverse proxy, no HTTPS), and is a bit complicated to deploy.
 
-The ideal deployment is similar to:
+The ideal architecture is `Docker-Compose`-driven, and looks similar to:
 
 ![Production BTCPay](https://raw.githubusercontent.com/btcpayserver/btcpayserver-docker/master/Production/Production.png)
 
-Please visit our [docker-compose for production environment](https://github.com/btcpayserver/btcpayserver-docker) to see how it works.
+Please visit [btcpayserver/btcpayserver-docker](https://github.com/btcpayserver/btcpayserver-docker) to see this production deployment and how it works.
diff --git a/Drupal.md b/Drupal.md
@@ -10,12 +10,14 @@ The project can be found [here](https://drupal.org/project/commerce_btcpay) on d
 
 ## Module installation and configuration
 
-### Quick walkthrough screencast:
+### Quick walkthrough screencast
+
 [![Drupal Commerce](https://img.youtube.com/vi/XBZwyC2v48s/mqdefault.jpg)](https://youtu.be/XBZwyC2v48s "BTCPay - Drupal Commerce 2.x quick walkthrough")
 
 ### Quick walkthrough steps
 
 #### Generate pairing code on BTCPay server
+
 1.  in store settings go to "**Access Tokens**"
 2.  click on **[Create a new token]**
 3.  **Label:** enter some label (eg. my store)
@@ -27,6 +29,7 @@ The project can be found [here](https://drupal.org/project/commerce_btcpay) on d
  (you will need that code below on gateway configuration, see below)
 
 #### Commerce BTCPay: Installation + configuration
+
 1.  install module: `composer require drupal/commerce_btcpay`
 2.  enable the module: `drush en commerce_btcpay -y`
 3.  make sure you have configured [private file system](https://www.drupal.org/docs/8/core/modules/file/overview#content-accessing-private-files) (needed to store encrypted public+private key)
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 btcpayserver
+Copyright (c) 2017-2018 BTCPayServer
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/LocalDevelopment.md b/LocalDevelopment.md
@@ -2,10 +2,11 @@
 
 ## Dependencies
 
-If you want to help development you need:
-
 * [.NET Core 2.0 SDK](https://microsoft.com/net/core/)
 * Docker
+* NBXplorer
+* PostgreSQL
+* Bitcoin Core (optionally other full nodes)
 
 ## Which IDE?
 
@@ -18,4 +19,4 @@ You need an instance of NBXplorer, Postgres, and Bitcoin Core running and config
 
 To simplify the development process we created a docker-compose file which setup everything for your dev environment, you can find all the information in [the README of the test project](https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer.Tests/README.md).
 
-Both Visual Studio Code and Visual Studio 2017 will run the debug profile Docker-Regtest, which will run a BTCPay server instance connecting to the services in your docker service so you can easily debug and step through the code.  
+Both Visual Studio Code and Visual Studio 2017 will run the debug profile Docker-Regtest, which will run a BTCPayServer instance connecting to the services in your Docker service, so you can easily debug and step through the code.  
diff --git a/ManualDeployment.md b/ManualDeployment.md
@@ -6,6 +6,6 @@ The process is basically the following:
 2. Clone and run [NBXplorer](https://github.com/dgarage/NBxplorer)
 3. Clone and run [BTCPay Server](https://github.com/btcpayserver/btcpayserver)
 
-Take a look to our video to learn more:
+Take a look at our video to learn more:
 
 [![BTCPay - Setup](http://img.youtube.com/vi/Xo_vApXTZBU/mqdefault.jpg)](http://www.youtube.com/watch?v=Xo_vApXTZBU "BTCPay - Setup")
diff --git a/README.md b/README.md
@@ -20,37 +20,42 @@ This solution is for you if:
 ## Documentation
 
 ### Getting started
-* [Try it on our test servers](Getting-Started.md)
 
-### Deployment
+* [Try it on our test servers](TryItOut.md)
 * [Architecture](Architecture.md)
-* [Manual deployment](ManualDeployment.md)
+
+### Deployment
+
+* [Azure deployment (simplest)](AzureDeployment.md)
 * [Docker deployment](DockerDeployment.md)
-* [Azure deployment](AzureDeployment.md)
-* [Third party hosting](Managed.md)
-* [Hosting Provider: How to deploy on LunaNode](https://medium.com/@BtcpayServer/hosting-btcpayserver-on-lunanode-bf9ef5fff75b)
-* ~~[Hosting Provider: How to deploy on time4vps](https://medium.com/@BtcpayServer/hosting-btcpay-server-for-cheap-2b27761fdb9d)~~ (They do not officially support docker yet)
+* [Manual deployment (not recommended)](ManualDeployment.md)
+* [Third party hosting](ThirdPartyHosting.md)
+* [BTC-accepting Hosting Provider: How to deploy on LunaNode](https://medium.com/@BtcpayServer/hosting-btcpayserver-on-lunanode-bf9ef5fff75b)
+* ~~[BTC-accepting Hosting Provider: How to deploy on time4vps](https://medium.com/@BtcpayServer/hosting-btcpay-server-for-cheap-2b27761fdb9d)~~ (They do not officially support docker yet)
 
-### Get engaged
-* [How to contribute](Local-Development.md)
-* [How to get support](Support.md)
-* [Connect with the community](Community.md)
+### Integrations
 
-### Integration
 * [Drupal](Drupal.md)
 * [Woocommerce](Woocommerce.md)
 * [Custom integration](CustomIntegration.md)
 
+### Tips & tricks
+
+* [FAQ](FAQ.md)
+* [How to change the domain name of your BTCPay Server](ChangeDomain.md)
+* [The guide for penny pinching your Microsoft Azure bill](PennyPinching.md)
+
+### Get engaged
+
+* [How to contribute](LocalDevelopment.md)
+* [How to get support](Support.md)
+* [Connect with the community](Community.md)
+
 ### Community articles
+
 * [The Ultimate Guide to BTCPay - The free and open-source Bitcoin Payment processor](https://www.reddit.com/r/Bitcoin/comments/8f1eqf/the_ultimate_guide_to_btcpay_the_free_and/)
 * [The Ultimate List of BTCPay Server Hosts and Merchants](https://bitcoinshirt.co/btcpay-stores/)
 * [Xadrez - Guide to run an open source based e-store that accepts Litecoin, Bitcoin and fiat](Xadrez.md)
 * [Third party hosted BTCPay servers - If you are looking for help with BTCPay Server](Managed.md)
 * [BTCPay Server official youtube channel](https://www.youtube.com/channel/UCpG9WL6TJuoNfFVkaDMp9ug)
 
-## Administrating your server
-* [How to change the domain name of your BTCPay Server](ChangeDomain.md)
-* [The guide for penny pinching your Microsoft Azure bill](PennyPinching.md)
-
-### More
-* [FAQ](FAQ.md)
diff --git a/Support.md b/Support.md
@@ -2,7 +2,7 @@
 
 This project is open source, and is not a company. Instead we rely on a network of contributors and users to provide support.
 
-Here are some member of the community that you can contact to get additional paid support,
+Here are some members of the community that you can contact to get additional paid support:
 
 ### Hubik Tomas
 
diff --git a/ThirdPartyHosting.md b/ThirdPartyHosting.md
@@ -1,6 +1,6 @@
-# Third party hosted BTCPay servers
+# Third-party hosting
 
-You are maybe interested in BTCPay Server, but you maybe don't have the necessary experience to set it up? Or you maybe want to be able to call somebody in case you have an issue? Please have a look at the following services, all have another focus:
+Are you interested in BTCPayServer, but not comfortable setting it up? Or maybe you want to be able to call somebody if you have an issue? Please have a look at the following services for third-party hosting:
 
 * [lightbo.lt](https://lightbo.lt)
 * [ltcpay.com](https://ltcpay.com/)
diff --git a/TryItOut.md b/TryItOut.md
@@ -1,4 +1,4 @@
-# Getting Started
+# Try it out
 
 This section goes through the process of creating an account and store on our public BTCPay server. (For evaluation purpose)
 
diff --git a/WooCommerce.md b/WooCommerce.md
@@ -1,6 +1,5 @@
 # WooCommerce integration
 
-You can checkout the following video, or head out to [the woocommerce plugin repository](https://github.com/btcpayserver/woocommerce-plugin).
-
-[![WooCommerce](https://img.youtube.com/vi/tTH3nLoyTcw/mqdefault.jpg)](https://www.youtube.com/watch?v=tTH3nLoyTcw "BTCPay - WooCommerce")
+You can check out the following video, or head over to [the WooCommerce plugin repository](https://github.com/btcpayserver/woocommerce-plugin).
 
+[![WooCommerce](https://img.youtube.com/vi/tTH3nLoyTcw/mqdefault.jpg)](https://www.youtube.com/watch?v=tTH3nLoyTcw "BTCPay - WooCommerce")

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Getting Started`
	`1`	`+# Try it out`
`2`	`2`
`3`	`3`	`This section goes through the process of creating an account and store on our public BTCPay server. (For evaluation purpose)`
`4`	`4`