Skip to content

Commit

Permalink
Updated and cleaned the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
namecoinq committed Sep 22, 2013
1 parent e9ecd4f commit b7cfcc9
Showing 1 changed file with 7 additions and 70 deletions.
77 changes: 7 additions & 70 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,16 @@
Namecoin
===================

See https://dot-bit.org/ for more project information.
Namecoin is a decentralized key/value registration and transfer system based on Bitcoin technology (a decentralized cryptocurrency).

Namecoin is a peer to peer naming system based on bitcoin. It is a secure and censorship resistant replacement for DNS.
It can be used for multiple purposes, for example a secure and censorship resistant replacement for DNS.

Ownership of a name is based on ownership of a coin, which is in turn based on public key cryptography. The namecoin network reaches consensus every few minutes as to which names have been reserved or updated.

It is envisioned that the .bit domain be used for gluing namecoin domain names into the DNS. This can be done close to the user or even by the user.
There is a FAQ.md to answer some general questions.

See FAQ.md for more general information.
See http://namecoin.info or http://dot-bit.org for more information.

News
=====================

Stable releases: only releases a tag that starts with "nc", that are signed and that do not end with -rc0-9 should be considered stable. All others are experimental.

IMPORTANT VALIDATION CHANGES at block 19200 and 24000!

* Effective at block 19200, merged mining comes into effect
* Also effective at block 19200, timetravel (2015-2016 retarget) hole is closed
* Effective at block 24000, names registered at block 12000 onward will expire after 36000 blocks instead of the current value of 12000
* Also effective at block 24000, the decline in network fees will speed up by a factor of 4

You must upgrade to the latest version nc0.3.24.\* before block 19200 or your client will start rejecting blocks and will be unable to participate in the network.

Technical
=====================
Expand All @@ -38,61 +25,11 @@ The protocol differences from bitcoin include:
* RPC calls for managing names
* Network fees to slow down the initial rush

Please read DESIGN-namecoind.md before proceeding.

BUILDING
======================
Please read DESIGN-namecoind.md for details.

Building is supported on Linux, Windows and Mac. Follow the bitcoin build instructions. Use "makefile.unix" for linux - it will generate namecoind. Usage is similar to bitcoind, plus new RPC calls for the new operations. A GUI is on the roadmap.

RUNNING
BUILDING
======================

You can acquire namecoins in the usual bitcoin way, by mining or by reciving some from others. After you have acquired some namecoins, use:

`namecoind name_new d/<name>`

This will reserve a name but not make it visible yet. Make a note of the short hex number. You will need it for the next step. (Do not shut down namecoind or you will also have to supply the longer hex code below.) Wait about 12 blocks, then issue:

`namecoind name_firstupdate d/<name> <rand> <value>`

`<rand>` is the short hex number from the previous step. This step will make the name visible to all.

after the first update, you can do more updates with:

`namecoind name_update d/<name> <value>`

and transfer to another person:

`namecoind name_update d/<name> <value> <address>`

dump your list of names:

`namecoind name_list`

dump the global list:

`namecoind name_scan`

VALUES
===================

Values for names in the d/ namespace are JSON encoded. The simplest value is of this form:

{"": "10.0.0.1", "map": {"www": "10.0.0.1"}}

A [full specification](http://dot-bit.org/Domain_names) is in progress.

DNS conduits
=============

SOCKS5/Tor name resolver: See `ncproxy` in the client sub-directory.

In the near future gzip encoding of the value will be possible, but ncproxy does not support this yet.

ROADMAP
===================
Building is supported on Linux, Windows and Mac. For building on windows you can use the scripts in ./contrib/easywinbuilder. Find build instructions on http://dot-bit.org.

* DNS zone conduit to allow normal DNS server to serve the .bit domain
* Firefox/chrome/... plugins
* GUI

0 comments on commit b7cfcc9

Please sign in to comment.