Merge #136: Change the nix-bitcoin deployment from forking this repo …

…to importing the module

b2e15c1 docs: Update to new deployment method (import instead of fork) (Jonas Nick)
5ed0284 Add fetch-release script (Jonas Nick)
c303cd4 Add push-release.sh helper (Jonas Nick)
705d187 examples/shell.nix: don't run shellHook on subsequent nix-shells (Erik Arvstedt)
65039be docs: Remove duplicate instructions (Jonas Nick)
455c566 docs: Replace tabs with spaces (Jonas Nick)
8aa4714 docs: Update NixOS version (Jonas Nick)
9df22a2 add deploy-qemu-vm.sh example (Erik Arvstedt)
548ced1 README: Add Example section (Jonas Nick)
44ccbb9 Clean up development shell.nix (Jonas Nick)
abcee65 add deploy-container.sh (Erik Arvstedt)
5dadea3 add deploy-nixops.sh (Erik Arvstedt)
0c74c36 mention performance loss with hardened kernel profile (Erik Arvstedt)
f312189 move main module import to configuration.nix (Erik Arvstedt)
0c0978c extract module 'deployment/nixops.nix', add option 'deployment.secretsDir' (Erik Arvstedt)
87d0286 Change the nix-bitcoin deployment from forking this repo to importing the module (Jonas Nick)

Pull request description:

Top commit has no ACKs.

Tree-SHA512: 18e8b71f42715c5e82e2dafde9dcc965594d76aacc6be7ee2ec746a9510065749cc65331687a57d7140f45779c3b7867f6260ec224d361fb5a477062a27d6e4c

.gitignore

@@ -1 +1 @@
-/secrets/
+/example/secrets/

README.md

@@ -4,7 +4,7 @@ nix-bitcoin
 [![Build Status](https://travis-ci.org/fort-nix/nix-bitcoin.svg?branch=master)](https://travis-ci.org/fort-nix/nix-bitcoin)
 
 Nix packages and nixos modules for easily installing Bitcoin nodes and higher layer protocols with an emphasis on security.
-This is a work in progress - don't expect it to be bug free or secure.
+This is a work in progress - don't expect it to be bug-free, secure or stable.
 
 The default configuration sets up a Bitcoin Core node and c-lightning. The user can enable spark-wallet in `configuration.nix` to make c-lightning accessible with a smartphone using spark-wallet.
 A simple webpage shows the lightning nodeid and links to nanopos letting the user receive donations.
@@ -24,6 +24,30 @@ The goal is to make it easy to deploy a reasonably secure Bitcoin node with a us
 It should allow managing bitcoin (the currency) effectively and providing public infrastructure.
 It should be a reproducible and extensible platform for applications building on Bitcoin.
 
+Example
+---
+The easiest way to try out nix-bitcoin is to use one of the provided examples.
+
+```
+git clone https://github.com/fort-nix/nix-bitcoin
+cd examples/
+nix-shell
+```
+
+The following example scripts set up a nix-bitcoin node according to `examples/configuration.nix` and then
+shut down immediately. They leave no traces (outside of `/nix/store`) on the host system.
+
+- `./deploy-container.sh` creates a [NixOS container](https://github.com/erikarvstedt/extra-container).\
+  This is the fastest way to set up a node.\
+  Requires: [NixOS](https://nixos.org/)
+
+- `./deploy-qemu-vm.sh` creates a QEMU VM.\
+  Requires: [Nix](https://nixos.org/nix/)
+
+- `./deploy-nixops.sh` creates a VirtualBox VM via [NixOps](https://github.com/NixOS/nixops).\
+  NixOps can be used to deploy to various other backends like cloud providers.\
+  Requires: [Nix](https://nixos.org/nix/), [VirtualBox](https://www.virtualbox.org)
+
 Available modules
 ---
 By default the `configuration.nix` provides:
@@ -48,8 +72,6 @@ The data directories of the services can be found in `/var/lib` on the deployed
 
 Installation
 ---
-The easiest way is to run `nix-shell` (on a Linux machine) in the nix-bitcoin directory and then create a [NixOps](https://nixos.org/nixops/manual/) deployment with the provided `network.nix` in the `network` directory.
-Fix the FIXMEs in configuration.nix and deploy with nixops in nix-shell.
 See [install.md](docs/install.md) for a detailed tutorial.
 
 Security