Skip to content

Commit 8b93447

Browse files
authored
Merge pull request #279 from dappnode/dapplion/main-readme
Update main readme
2 parents 01c4b26 + 268c8db commit 8b93447

File tree

4 files changed

+90
-136
lines changed

4 files changed

+90
-136
lines changed

README.md

+90-62
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,123 @@
11
# DAppNode
22

33
[![Website dappnode.io](https://img.shields.io/badge/Website-dappnode.io-brightgreen.svg)](https://dappnode.io/)
4-
[![Documentation Wiki](https://img.shields.io/badge/Documentation-Wiki-brightgreen.svg)](https://github.com/dappnode/DAppNode/wiki)
4+
[![Documentation Wiki](https://img.shields.io/badge/Documentation-Wiki-brightgreen.svg)](https://docs.dappnode.io)
55
[![GIVETH Campaign](https://img.shields.io/badge/GIVETH-Campaign-1e083c.svg)](https://beta.giveth.io/campaigns/5b44b198647f33526e67c262)
66
![GitHub All Releases](https://img.shields.io/github/downloads/dappnode/DAppNode/total.svg)
77
[![Twitter Follow](https://img.shields.io/twitter/follow/espadrine.svg?style=social&label=Follow)](https://twitter.com/DAppNODE?lang=es)
88

9-
[![](https://github.com/dappnode/DAppNode/raw/master/doc/DAppNodeLogoWide.png)](https://github.com/dappnode/DAppNode/wiki/DAppNode-Installation-Guide)
10-
9+
<br/>
1110
<p align="center">
12-
<a href="https://github.com/dappnode/DAppNode/wiki/DAppNode-Installation-Guide">
13-
<img width="300" height="87" src="https://github.com/dappnode/DAppNode/raw/master/doc/DappnodeInstall.png">
11+
<a href="https://dappnode.io/">
12+
<img width="800" src="doc/DAppNodeLogoWide-outlined.png">
1413
</a>
1514
</p>
16-
1715
<br/>
16+
<p align="center">
17+
<a href="https://install.dappnode.io">
18+
<img width="200" src="doc/DappnodeInstall.png">
19+
</a>
20+
</p>
1821
<br/>
1922

20-
What happens when you want to use a Decentralized P2P network, but securing your own nodes takes a lot of time and effort?
21-
22-
You have a decentralization bottleneck at the entry point, which is where we are now in the blockchain space :-(
23-
24-
1. At no point in the last 2 years has there been more than 13,000 Bitcoin nodes online and that number got as low as [5500](https://bitnodes.earn.com/dashboard/?days=730)
23+
### Infrastructure for the decentralized world
2524

26-
2. MetaMask and MyEtherWallet/MyCrypto are the primary wallets used on Ethereum and most users are using these wallets’ default nodes… This is a huge centralizing force in Ethereum.
25+
DAppNode is empowering people by creating a simple, transparent system for hosting P2P clients for DApps, Cryptocurrencies, VPNs, IPFS and more
2726

28-
3. The people who do run their own node end up [having to spend a lot of time troubleshooting](https://www.reddit.com/r/ethereum/comments/83a34l/centralization_in_ethereum_infura_metamask/), keeping it updated and synced without the ability to easily share their node (and efforts) with family and friends.
27+
- Read about our purpose and mission https://dappnode.io/
28+
- Join our community https://discord.gg/c28an8dA5k
29+
- Check out what we are delivering https://medium.com/dappnode
30+
- Share your ideas and support from us https://discourse.dappnode.io/
2931

30-
DAppNode will address these issues by creating a simple, easy, self-empowering system made specifically for hosting P2P clients for DApps, Cryptocurrencies, VPNs, IPFS, and more.
32+
# Discover DAppNode
3133

32-
Members of the [WHG](https://motherboard.vice.com/en_us/article/qvp5b3/how-ethereum-coders-hacked-back-to-rescue-dollar208-million-in-ethereum?lipi=urn%253Ali%253Apage%253Ad_flagship3_profile_view_base_treasury%253B7v09na8XQqySEuI%252FPn%252Bx5Q%253D%253D) have spent countless hours developing DAppNode because they believe it to be the most important and pertinent censorship resistant tool that is to be built to help bring the decentralized world everyone wants for themselves, and their friends and family.
34+
DAppNode lowers the barrier of entry for non tech-savy participants. It allows you to deploy, update, and manage P2P clients and nodes without leaving your browser. No terminal or command line interface.
3335

34-
# The Desired Final User Story:
36+
<p align="center">
37+
<a href="https://install.dappnode.io">
38+
<img width="800" src="doc/DAppNodeAdminUI-demo.png">
39+
</a>
40+
</p>
3541

36-
1. Vojtech has several cryptocurrencies he follows and is ready to stop using his laptop to run clients, but doesn’t want to have to pay a monthly subscription in fiat to some company he doesn’t trust with his private keys.
42+
# Develop with DAppNode
3743

38-
2. He hears about DAppNode and decides to buy the top of the line DAppNode Server preloaded from shop.dappnode.io (though he could buy his own server and install the software himself).
44+
DAppNode modular architecture allows any team to or project to publish a dockerized application to the DAppNode packages eco-system. Benefit from an enthusiatic crypto savy user based and offer a user interface-only experience to lower onboarding friction.
3945

40-
3. The DAppNode Server is delivered to his front door, and when Vojtech opens the box he finds a 2 step instruction card: First, plug in the Server. Second, go to welcome.dappnode.io.
46+
Check out the [DAppNodeSDK](https://github.com/dappnode/DAppNodeSDK) to learn how to get started.
4147

42-
4. On this website there will be an extremely simple and short walk-thru for Vojtech to set up his credentials and choose which clients to deploy.
48+
_Note: packages are published to Ethereum mainnet and incur costs. Given the current high gas prices the DAppNode team is willing to subsidize gas costs for packages of great interest to users._
4349

44-
5. By just checking a few boxes Vojtech deployed his own VPN; his own local instance of MyCrypto.com; Ethereum, Bitcoin, Monero and Dogecoin Full nodes; a Zcash Secure Node and DASH Master Node; he joined the IPFS Consortium and deployed a TrueBit Verifier and Livepeer node; and hosted Giveth, Swarm City, Aragon, Colony, and Decentraland Helper DApps to support these projects and to ensure that his interaction with these DApps cannot be censored and are fully trustless.
50+
# Packages eco-system
4551

46-
6. Vojtech then tells his friends and family that he is the admin for his own DAppNode and he is able to give them a link that sets them up with their own credentials and access to his DAppNode, and Vojtech can deploy any other DApps that him or his friends and family want to have hosted with a couple clicks. He has become the trusted gateway to the decentralized world for his entire community.
52+
The community and core team members have created many useful packages for users. Checkout the [**package explorer**](https://explorer.dappnode.io) to browse an up-to-date list of all packages and their versions.
4753

48-
7. Vojtech ends up being able to pay off the cost of his DAppNode in 2 months with the profits made from his ZenCash, Trustlines Validator, ETH2.0 validator, DASH and TrueBit Nodes. He also canceled his VPN and all of his Digital Ocean accounts because now he has his own server that he can host all of his services on. Without even trying, Vojtech has a couple extra hundred dollars a month because he is running DAppNode on his own personal server.
54+
<p align="center">
55+
<a href="https://explorer.dappnode.io">
56+
<img width="600" src="doc/DAppNodeExplorer.png">
57+
</a>
58+
</p>
4959

50-
Though the above story is not ready yet, we are developing in an invitingly open source manner and anyone can use their own hardware and run DAppNode on it.
60+
## Champions
61+
62+
Champions are community members that are in charge of maintaining packages updated. All packages in this list without a champions are actively looking for a champion. Join our [DAppNode Discord **#champion-process**](https://discord.gg/MhSPBsHryu) to suggest a package to be championed and/or offer to be a champion for a project you care about!
63+
64+
| Package | Champion |
65+
| ---------------------------------------------------------------------------------------- | ---------------- |
66+
| [Avalanche](https://github.com/Colm3na/DAppNodePackage-avalanche) | - |
67+
| [ARTIS-sigma1](https://github.com/lab10-coop/DAppNodePackage-ARTIS-sigma1) | - |
68+
| [Bee](https://github.com/dappnode/DAppNodePackage-bee) | @tropicar |
69+
| [Bitcoin](https://github.com/dappnode/DAppNodePackage-bitcoin) | @Pol-Lanski |
70+
| [Block-explorer](https://github.com/dappnode/DappnodePackage-block-explorer) | - |
71+
| [Cosmos](https://github.com/Colm3na/DAppNodePackage-cosmos) | - |
72+
| [DMS](https://github.com/dappnode/DAppNodePackage-DMS) | - |
73+
| [Eth2stats-client](https://github.com/dappnode/DAppNodePackage-eth2stats-client) | - |
74+
| [Ethereum Classic](https://github.com/dappnode/DAppNodePackage-ethereum-classic) | - |
75+
| [Ethereum Optimism](https://github.com/dappnode/DAppNodePackage-ethereum-optimism) | - |
76+
| [Exporter](https://github.com/dappnode/DAppNodePackage-exporter) | - |
77+
| [Geth](https://github.com/dappnode/DAppNodePackage-geth) | - |
78+
| [Goerli Geth](https://github.com/dappnode/DAppNodePackage-goerli-geth) | - |
79+
| [Grin](https://github.com/dappnode/DAppNodePackage-grin) | - |
80+
| [HTTPs Portal](https://github.com/dappnode/DAppNodePackage-https-portal) | - |
81+
| [Ipfs Cluster](https://github.com/dappnode/DAppNodePackage-ipfs-cluster) | - |
82+
| [Ipfs Pinner](https://github.com/dappnode/DAppNodePackage-ipfs-pinner) | - |
83+
| [Kovan](https://github.com/dappnode/DAppNodePackage-kovan) | - |
84+
| [LightningNetwork](https://github.com/dappnode/DAppNodePackage-LightningNetwork) | @pablomendezroyo |
85+
| [Matrix](https://github.com/dappnode/DAppNodePackage-matrix) | - |
86+
| [Metrics Tools](https://github.com/dappnode/DAppNodePackage-metrics-tools) | - |
87+
| [Monero](https://github.com/dappnode/DAppNodePackage-monero) | @pablomendezroyo |
88+
| [Nethermind](https://github.com/dappnode/DAppNodePackage-nethermind) | - |
89+
| [Openethereum](https://github.com/dappnode/DAppNodePackage-openethereum) | - |
90+
| [Owncloud](https://github.com/dappnode/DAppNodePackage-owncloud) | - |
91+
| Polkadot Kusama | @tropicar |
92+
| [Prysm](https://github.com/dappnode/DAppNodePackage-prysm) | @pablomendezroyo |
93+
| [Prysm Pyrmont](https://github.com/dappnode/DAppNodePackage-prysm-pyrmont) | @pablomendezroyo |
94+
| [Raiden](https://github.com/dappnode/DAppNodePackage-raiden) | - |
95+
| [Raiden Testnet](https://github.com/dappnode/DAppnodePackage-raiden-testnet) | - |
96+
| [Rinkeby](https://github.com/dappnode/DAppNodePackage-rinkeby) | - |
97+
| [Ropsten](https://github.com/dappnode/DAppNodePackage-ropsten) | - |
98+
| [Storj](https://github.com/dappnode/DAppNodePackage-storj) | @pablomendezroyo |
99+
| [Tornado Cash Relayer](https://github.com/dappnode/DAppNodePackage-Tornado-Cash-Relayer) | - |
100+
| [Trustlines](https://github.com/dappnode/DAppNodePackage-trustlines) | - |
101+
| [Trustlines bridge](https://github.com/dappnode/DAppNodePackage-trustlines-bridge) | - |
102+
| [Trustlines monitor](https://github.com/dappnode/DAppNodePackage-trustlines-monitor) | - |
103+
| [Trustlines netstats](https://github.com/dappnode/DAppNodePackage-trustlines-netstats) | - |
104+
| [Trustlines validator](https://github.com/dappnode/DAppNodePackage-trustlines-validator) | - |
105+
| [Turbo-geth](https://github.com/dappnode/DAppNodePackage-turbo-geth) | - |
106+
| [Vipnode](https://github.com/dappnode/DAppNodePackage-vipnode) | - |
107+
| [Wireguard](https://github.com/dappnode/DAppNodePackage-wireguard) | - |
108+
| [ZCash](https://github.com/dappnode/DAppNodePackage-zcash) | - |
109+
110+
# Core packages
51111

52-
We are open to receive funding to help pay the developers working hard on the software!
112+
- [DNP_DAPPMANAGER](https://github.com/dappnode/DNP_DAPPMANAGER)
113+
- [DNP_VPN](https://github.com/dappnode/DNP_VPN)
114+
- [DNP_IPFS](https://github.com/dappnode/DNP_IPFS)
115+
- [DNP_BIND](https://github.com/dappnode/DNP_BIND)
53116

54117
# Team members
55118

119+
Members of the [White Hat Group (WHG)](https://motherboard.vice.com/en_us/article/qvp5b3/how-ethereum-coders-hacked-back-to-rescue-dollar208-million-in-ethereum) have spent countless hours boostraping and developing DAppNode in 2017. Currently, the project is mantained by a growing multi-disciplary team:
120+
56121
- **Adviser & Instigator:** Jordi Baylina
57122
- **Project Lead:** Eduadiez
58123
- **Developer Lead:** dapplion
@@ -61,43 +126,6 @@ We are open to receive funding to help pay the developers working hard on the so
61126
- **Developer:** Carlos
62127
- **Adviser:** Griff Green
63128

64-
# Where the DAppers play
65-
66-
[DAppNode](https://dappnode.io/)
67-
68-
[Discourse](https://discourse.dappnode.io/)
69-
70-
[Github](https://github.com/dappnode/DAppNode/wiki/DAppNode-Installation-Guide)
71-
72-
# **Benefits of DAppNode**
73-
74-
- Easy set up
75-
- Trustless system
76-
- Invitingly Open Source
77-
- Free up space on your Devices
78-
- Great for Proof of Stake mining
79-
- You can browse `.eth` domains like the normal web
80-
- You take control of your Nodes
81-
- Encourages people to have their own server
82-
- Perfect for projects that reward you for hosting, (Filecoin, Storj, etc)
83-
- Can facilitate a P2P economy
84-
- Host any P2P networking protocols
85-
- DApp teams can develop packages their users can run 24x7
86-
- Never trust a hosting provider with your private keys again!
87-
- One click node deployment (Full Nodes, DApps)
88-
- Censorship resistance (run your own VPN)
89-
- 1 DAppNode can support an entire Community
90-
- DAppNode will build communities and decrease centralization
91-
- DAppNode is the most important piece of infrastructure for our decentralized future
92-
- Considering all of the incentive structures to run nodes, most DAppNode Admins will be make a profit maintaining their own DAppNode
93-
94-
# Core repos
95-
96-
- [DNP_DAPPMANAGER](https://github.com/dappnode/DNP_DAPPMANAGER)
97-
- [DNP_VPN](https://github.com/dappnode/DNP_VPN)
98-
- [DNP_IPFS](https://github.com/dappnode/DNP_IPFS)
99-
- [DNP_BIND](https://github.com/dappnode/DNP_BIND)
100-
101129
## License
102130

103131
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details

doc/DAppNodeAdminUI-demo.png

28.9 KB
Loading

doc/DAppNodeLogoWide-outlined.png

32.2 KB
Loading

0 commit comments

Comments
 (0)