Skip to content

Commit 02cd10c

Browse files
committed
Update readme
1 parent 84e6284 commit 02cd10c

File tree

4 files changed

+13
-54
lines changed

4 files changed

+13
-54
lines changed

README.md

Lines changed: 13 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,40 @@
1-
# Rocket Pool - A next generation Ethereum proof of stake (PoS) infrastructure service and pool [![Build Status](https://travis-ci.org/rocket-pool/rocketpool.svg?branch=master)](https://travis-ci.org/rocket-pool/rocketpool)
2-
3-
*NOTE: The current version of Rocket Pool requires the latest [ganache-cli@v6.12.1](https://github.com/trufflesuite/ganache-cli), [truffle@v5.1.51](https://github.com/trufflesuite/truffle), and [NodeJS@12.18.3 LTS](https://nodejs.org/en/download/package-manager/) or greater to run locally.
1+
# Rocket Pool - Decentralised Ethereum liquid staking protocol
42

53
<p align="center">
64
<img src="https://raw.githubusercontent.com/rocket-pool/rocketpool/master/images/logo.png?raw=true" alt="Rocket Pool - Next Generation Decentralised Ethereum Proof-of-Stake (PoS) Infrastructure Service and Pool" width="500" />
75
</p>
86

9-
---
7+
Rocket Pool is the base layer protocol for decentralised and trustless ETH staking, both liquid using rETH and node operator staking.
8+
9+
Designed to support stakers of all shapes and sizes, Rocket Pool was built with the intent to allow anyone to trustlessly stake ETH to a network of decentralised node operators with full autonomy using protocol based incentives to make sure all parties work in each others best interests.
1010

11-
`Rocket Pool 2.5` is a first of its kind Ethereum Proof of Stake (PoS) infrastructure service, designed to be highly decentralised, distributed and compatible with staking in Ethereum 2.0 on the beacon chain. It was first conceived in late 2016 and has since had several successful public betas over the life span of ETH2 development. The staking network allows any individual, business, defi dapp, wallet provider, SaaS provider, exchange — just about any service — the ability to provide their users with the option to earn staking rewards on their ETH holdings without worrying about maintaining an extensive staking infrastructure, just plug and play.
11+
The core premise behind a protocol is to ensure the network is not beholden to any one party. This is a principle directly linked to Ethereum itself, and a mindset used at every stage of the process as Rocket Pool was developed.
1212

13-
Staking with the Rocket Pool network is very flexible and unlike any other staking infrastructure for Ethereum 2.0 to date. When depositing ETH into the Rocket Pool smart contracts, you will be instantly issued a token called rETH which represents a tokenised staking deposit in the network. Its value and the rewards it gains over time will be reflected by the work each individual decentralised node operator gives the Rocket Pool network. Rocket Pool’s unique decentralised staking infrastructure is economically bonded to both be secure and scalable.
13+
Rocket Pool strives to bring staking to the masses and embody the core ethos of Ethereum, DeFi, specifically the non-custodial, trustless nature that allows self-sovereignty to truly thrive in a decentralised ecosystem.
1414

15-
Rocket Pool isn't just a whitepaper, it's actual code. Be sure to read the [Rocket Pool 101 - FAQ for more information](https://medium.com/rocket-pool/rocket-pool-101-faq-ee683af10da9).
15+
This is why creating the decentralised staking protocol layer for ETH is so important, especially with the vast majority of players either not having the technical skills to run a node, or the financial capacity to own 32 ETH.
1616

1717
# Test Rocket Pool
1818

1919
<p align="center">
20-
<img src="https://raw.githubusercontent.com/rocket-pool/rocketpool/master/images/rocket-pool-casper-pos-beacon-chain-test.png?raw=true" alt="Rocket Pool - Testing Ethereum Proof-of-Stake (PoS) Infrastructure Service and Pool for Ethereum 2.0 Beacon Chain"/>
20+
<img src="https://raw.githubusercontent.com/rocket-pool/rocketpool/master/images/rocket-pool-atlas-test.png?raw=true" alt="Rocket Pool - Testing Ethereum Proof-of-Stake (PoS) Infrastructure Service and Pool for Ethereum 2.0 Beacon Chain"/>
2121
</p>
2222

2323
To see Rocket Pool in action, clone the repo and run Ganache with the latest version of truffle installed. A quick and easy way to do this is to use the test script provided with the project:
2424
```bash
2525
$ npm install && npm test
2626
```
27-
This will start Ganache (if not already started) with the current block gas limit and put Rocket Pool through its paces. * These tests are extensive and can take up to 2-10 mins to run depending on your machines specs *.
28-
29-
# Rocket Pool White Paper
30-
31-
You can read the current Rocket Pool white paper here: [http://www.rocketpool.net/files/RocketPoolWhitePaper.pdf](http://www.rocketpool.net/files/RocketPoolWhitePaper.pdf).
27+
This will start a local development node (if not already started) and put Rocket Pool through its paces. * These tests are extensive and can take up to 2-10 mins to run depending on your machines specs *.
3228

3329
# Contact and Additional Information
3430

3531
Check out [our website](http://www.rocketpool.net) for more information on Rocket Pool.
3632

37-
Contact form: https://www.rocketpool.net/#contact
38-
39-
Twitter: https://twitter.com/Rocket_Pool
40-
41-
Join our Discord chat channel! https://discordapp.com/invite/9mwXaDY
33+
Read [our explainer series](https://medium.com/rocket-pool/rocket-pool-staking-protocol-part-1-8be4859e5fbd) for a 1000 foot overview of the protocol.
4234

43-
---
35+
Read [our docs](https://docs.rocketpool.net) for more technical information on running a node.
4436

45-
# A Step-by-Step Beginners Guide
37+
Follow us on twitter at [@Rocket_Pool](https://twitter.com/Rocket_Pool)
4638

47-
The following worked example uses macOS Sierra 10.12.6 and VMware Fusion 8.5.8 - all versions correct as of 15/09/2017.
39+
Join [our Discord chat channel](https://discord.gg/rocketpool)!
4840

49-
Download and install Ubuntu onto a new VM -> https://www.ubuntu.com/download/desktop - tested with v16.04
50-
51-
Open a terminal window and install some pre-requisites:
52-
53-
install git:
54-
```bash
55-
$ sudo apt -y install git
56-
```
57-
install curl:
58-
```bash
59-
$ sudo apt -y install curl
60-
```
61-
install npm:
62-
```bash
63-
$ sudo apt -y install npm
64-
```
65-
install node.js:
66-
```bash
67-
$ curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -
68-
$ sudo apt-get -y install nodejs
69-
```
70-
get rocketpool:
71-
```bash
72-
$ git clone https://github.com/rocket-pool/rocketpool
73-
```
74-
open the rocketpool directory:
75-
```bash
76-
$ cd rocketpool
77-
```
78-
install npm packages and run tests:
79-
```bash
80-
$ npm install && npm test
81-
```

images/logo.png

-130 KB
Loading
-136 KB
Binary file not shown.
-44.4 KB
Binary file not shown.

0 commit comments

Comments
 (0)