Update README (#709)

* update docs to add guides and update "what is nano?" system

* add whitepaper to guides and docs

* update features list

* update what is nano header level
This commit is contained in:
Braden Napier 2018-03-08 03:17:14 -08:00 committed by Russel Waters
commit 6d6ad17c33
2 changed files with 40 additions and 19 deletions

View file

@ -1,33 +1,53 @@
<hr />
<div align="center">
<img src="images/logo.svg" alt="Logo" width='300px' height='auto'/>
</div>
<hr />
[![Build Status](https://travis-ci.org/nanocurrency/raiblocks.svg?branch=master)](https://travis-ci.org/nanocurrency/raiblocks)
# What is Nano?
Nano is designed to be a feeless, instant, high throughput cryptocurrency.
### What is Nano?
We've applied the philosophy of "do one thing and do it well", giving you performance and scalability unmatched by any other platform.
---
### Key features
* Nano utilizes a novel block-lattice architecture, unlike conventional blockchains used in many other cryptocurrencies.
Nano's goal is to become _"a global currency with instantaneous transactions and zero fees over a secure, decentralized network."_
We've applied the philosophy of _"do one thing and do it well"_, we are focused on building the best medium for value exchange in the world.
---
### Key Features
* Nano utilizes a novel [block-lattice](https://github.com/nanocurrency/raiblocks/wiki/Block-lattice) architecture, unlike conventional blockchains used in many other cryptocurrencies.
* The network requires minimal resources, no high-power mining hardware, and can process high transaction throughput.
* Offers feeless, instantaneous transactions, as well as unlimited scalability, making Nano ideal for peer-to-peer transactions.
* Offers instantaneous transactions with zero fees and unlimited scalability, making Nano an ideal solution for peer-to-peer transactions.
* As of December 2017, the Nano network has processed over four million transactions with an unpruned ledger size of only 1.7GB.
For more information, see [Nano.org](https://nano.org/) or read the [whitepaper](https://nano.org/en/whitepaper).
### Resources
- [Nano website](https://nano.org)
- [Whitepaper](https://nano.org/en/whitepaper)
- [Roadmap](https://raiblocks.net/media/raiblocks-roadmap-v2-en.png)
- [Discord chat](https://chat.nano.org/)
- [Reddit](https://reddit.com/r/nanocurrency)
- [Medium](https://medium.com/@nanocurrency)
- [Twitter](https://twitter.com/nanocurrency)
- [Forum](https://forum.raiblocks.net/)
- [GitHub wiki](https://github.com/nanocurrency/raiblocks/wiki)
### Guides & Documentation
### Build instructions
https://github.com/nanocurrency/raiblocks/wiki/Build-Instructions
* [White Paper](https://nano.org/en/whitepaper)
* [Build Instructions](https://github.com/nanocurrency/raiblocks/wiki/Build-Instructions)
* [Command Line Interface](https://github.com/nanocurrency/raiblocks/wiki/Command-line-interface)
* [RPC Protocol](https://github.com/nanocurrency/raiblocks/wiki/RPC-protocol)
* [Wallet Design](https://github.com/nanocurrency/raiblocks/wiki/Wallet-design)
* [Block Lattice](https://github.com/nanocurrency/raiblocks/wiki/Block-lattice)
* [Design Features](https://github.com/nanocurrency/raiblocks/wiki/Design-features)
### Links & Resources
* [Nano Website](https://nano.org)
* [Nano Roadmap](https://raiblocks.net/media/raiblocks-roadmap-v2-en.png)
* [Discord Chat](https://chat.nano.org/)
* [Reddit](https://reddit.com/r/nanocurrency)
* [Medium](https://medium.com/@nanocurrency)
* [Twitter](https://twitter.com/nanocurrency)
* [Forum](https://forum.raiblocks.net/)
* [GitHub wiki](https://github.com/nanocurrency/raiblocks/wiki)
### Want to Contribute?
### Want to contribute?
Please see the [contributors guide](https://github.com/nanocurrency/raiblocks/wiki/Contributing).
### Contact us

1
images/logo.svg Normal file
View file

@ -0,0 +1 @@
<svg id="Layer_1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 216 29.4"><style>.st0{fill:#4a90e2}.st1{fill:#000034}</style><circle class="st0" cx="4.8" cy="24.4" r="4.8"/><path class="st0" d="M62 .6c-2.6 0-4.8 2.1-4.8 4.8 0 3.8-.6 4.8-4.8 4.8H52c-2.4.2-4.3 2.2-4.3 4.7v.1c0 3.7-.7 4.6-4.8 4.6-.2 0-.4 0-.5.1-2.4.3-4.3 2.3-4.3 4.7 0 2.6 2.1 4.8 4.8 4.8 2.5 0 4.6-2 4.7-4.4v-.4c0-3.4 1.1-4.7 4.7-4.8h.1c2.5 0 4.6-2 4.7-4.5v-.3c0-3.5 1.1-4.8 4.8-4.8 2.6 0 4.8-2.1 4.8-4.8 0-2.5-2.1-4.6-4.7-4.6zM33.8 10.2h-.4c-4.2 0-4.8-1-4.8-4.8 0-2.6-2.1-4.8-4.8-4.8C21.2.6 19 2.7 19 5.4c0 3.8-.6 4.7-4.8 4.7h-.4c-2.4.2-4.3 2.2-4.3 4.7 0 2.6 2.1 4.8 4.8 4.8 2.5 0 4.6-2 4.7-4.4v-.3c0-3.5 1.1-4.8 4.8-4.8 3.7 0 4.8 1.3 4.8 4.7 0 2.6 2.1 4.8 4.8 4.8s4.8-2.1 4.8-4.8c-.1-2.4-2-4.4-4.4-4.6z"/><g><path class="st1" d="M109.3.8c-.3 0-.6.1-.8.4-.2.2-.3.5-.3.9V25L90.7 1.4c-.3-.4-.6-.6-1-.6s-.7.1-.9.4c-.2.2-.3.5-.3.9v26c0 .4.1.7.3.9.2.2.5.3.9.3.3 0 .6-.1.8-.4.2-.2.3-.5.3-.9V5.2l17.5 23.6c.3.4.7.6 1.1.6.4 0 .7-.1.9-.4.2-.2.3-.5.3-.9v-26c0-.4-.1-.7-.3-.9-.3-.3-.6-.4-1-.4zm92-.8c-8.1 0-14.7 6.6-14.7 14.7s6.6 14.7 14.7 14.7S216 22.8 216 14.7 209.4 0 201.3 0zm0 27c-6.8 0-12.3-5.5-12.3-12.3s5.5-12.3 12.3-12.3 12.3 5.5 12.3 12.3S208.1 27 201.3 27zM177 .8c-.3 0-.6.1-.8.4-.2.2-.3.5-.3.9V25L158.4 1.4c-.3-.4-.6-.6-1-.6s-.7.1-.9.4c-.2.2-.3.5-.3.9v26c0 .4.1.7.3.9.2.2.5.3.9.3.3 0 .6-.1.8-.4.2-.2.3-.5.3-.9V5.2L176 28.8c.3.4.7.6 1.1.6.4 0 .7-.1.9-.4.2-.2.3-.5.3-.9v-26c0-.4-.1-.7-.3-.9-.3-.3-.6-.4-1-.4zm-42.3.8c-.1-.3-.3-.5-.5-.6-.3-.2-.5-.2-.8-.2-.6 0-1.1.3-1.3.9l-11.7 26.2c-.1.1-.1.3-.1.4 0 .3.1.6.3.8.2.2.5.3.8.3.5 0 .9-.3 1.1-.8l3.1-7h15.5l3 7c.1.2.3.4.5.6.2.1.4.2.6.2.3 0 .6-.1.8-.3.2-.2.4-.4.4-.7 0-.2 0-.3-.1-.5L134.7 1.6zm-8.2 17.9L133.3 4l6.8 15.5h-13.6z"/></g></svg>

After

Width:  |  Height:  |  Size: 1.7 KiB