aboutsummaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
authorWei-Ning Huang <w@byzantine-lab.io>2019-09-01 14:20:30 +0800
committerWei-Ning Huang <w@byzantine-lab.io>2019-09-01 14:20:30 +0800
commitc0b7a59fa92a8850a6fdd4fe8309a5f69ec55c26 (patch)
tree5f8df41a21566aa0923fc788b1cee733c5952e32 /docs/README.md
downloadtangerine-wiki-c0b7a59fa92a8850a6fdd4fe8309a5f69ec55c26.tar
tangerine-wiki-c0b7a59fa92a8850a6fdd4fe8309a5f69ec55c26.tar.gz
tangerine-wiki-c0b7a59fa92a8850a6fdd4fe8309a5f69ec55c26.tar.bz2
tangerine-wiki-c0b7a59fa92a8850a6fdd4fe8309a5f69ec55c26.tar.lz
tangerine-wiki-c0b7a59fa92a8850a6fdd4fe8309a5f69ec55c26.tar.xz
tangerine-wiki-c0b7a59fa92a8850a6fdd4fe8309a5f69ec55c26.tar.zst
tangerine-wiki-c0b7a59fa92a8850a6fdd4fe8309a5f69ec55c26.zip
Add wiki material
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..256f50d
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,29 @@
+# Getting Started
+
+Tangerine is a permissionless, proof-of-stake blockchain system that features high throughput and low latency. Current mainnnet is able to reach 10K TPS, and maintain ~ 1 second confirmation latency.
+
+This documentation shows your way around [Tangerine](https://tangerine-network.io), the next generation blockchain platform.
+
+## Overview
+
+#### Accessing Tangerine Network
+
+To create a Tangerine wallet and start using Tangerine blockchain platform, follow [wallet creation guide](Create-Wallet.md).
+
+#### DApp Development
+
+- To learn abour DApp (decentralized apps) development and build DApps on Tangerine, follow [DApp development guide](Dapp-Development-Guide.md).
+- If you have already developed DApps on Ethereum and is planning to move your existing DApp onto Tangerine, check out [Etherum DApp migration guide](Migrate-from-Ethereum.md).
+
+#### Node Operation
+
+- To run a BP (block producing) full-node, follow [BP node operation guide](BP-Node-Operation-Guide.md).
+- If you simply need to communicate to Tangerine network, like sending transactions or looking up network state, follow [RPC node operation guide](RPC-Node-Operation-Guide.md).
+
+#### Fullnode Development
+
+You can contribute to the development of Tangerine itself! Get started with [Tangerine fullnode development guide](Fullnode-Development.md).
+
+#### Technical Documentations
+
+To learn more about how Tangerine works, check out our [technical documenations](Technical-Documentations.md)