From c00601743c50c99930a20d91ac8b42baa9b9ad77 Mon Sep 17 00:00:00 2001
From: rllola <rllola80@gmail.com>
Date: Tue, 12 Feb 2019 22:09:47 +0100
Subject: [PATCH] Added README for zeroname plugin with instructions

---
 plugins/Zeroname/README.md | 61 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 plugins/Zeroname/README.md

diff --git a/plugins/Zeroname/README.md b/plugins/Zeroname/README.md
new file mode 100644
index 00000000..7f663686
--- /dev/null
+++ b/plugins/Zeroname/README.md
@@ -0,0 +1,61 @@
+# ZeroName
+
+Zeroname plugin to connect Namecoin and register all the .bit domain name.
+
+## Start
+
+You can create your own Zeroname.
+
+### Namecoin node
+
+You need to run a namecoin node.
+
+[Namecoin](https://namecoin.org/download/)
+
+You will need to start it as a RPC server.
+
+Example of `~/.namecoin/namecoin.conf` minimal setup:
+```
+daemon=1
+rpcuser=your-name
+rpcpassword=your-password
+rpcport=8336
+server=1
+txindex=1
+```
+
+Don't forget to change the `rpcuser` value and `rpcpassword` value!
+
+You can start your node : `./namecoind`
+
+### Update `updater/zeroname_updater.py`
+
+
+You need update lines 117-118 with the correct `rpcuser` and `rpcpassword`.
+```
+    'user': 'PLACEHOLDER',
+    'password': 'PLACEHOLDER',
+```
+
+You will also need to create a site `python zeronet.py createSite` and regitser the info.
+
+In the site you will need to create a file `./data/<your-site>/data/names.json` with this is it:
+```
+{}
+```
+
+### `zeroname_config.json` file
+
+In `~/.namecoin/zeroname_config.json`
+```
+{
+  "lastprocessed": 223910,
+  "zeronet_path": "/root/ZeroNet", # Update with your path
+  "privatekey": "", # Update with your private key of your site
+  "site": "" # Update with the address of your site
+}
+```
+
+### Run updater
+
+You can now run the script : `updater/zeroname_updater.py` and wait until it is fully sync (it might take a while).