Skip to content

Commit

Permalink
Update nits
Browse files Browse the repository at this point in the history
  • Loading branch information
howardwu committed Aug 16, 2020
1 parent 4d24659 commit 87d9993
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 7 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<a href="https://codecov.io/gh/AleoHQ/snarkOS"><img src="https://codecov.io/gh/AleoHQ/snarkOS/branch/master/graph/badge.svg?token=cck8tS9HpO"/></a>
</p>

__snarkOS__ is a decentralized operating system for confidential programs.
__snarkOS__ is a decentralized operating system for private applications.

## <a name='TableofContents'></a>Table of Contents

Expand Down Expand Up @@ -83,7 +83,30 @@ docker run -d -p 4130:4130 --name snarkos snarkos

## 3. Usage Guide

\[WIP\]
To start a client node, run:
```
snarkos
```

To start a mining node, run:
```
snarkos --is-miner
```

#### How to guard RPC endpoints
```
./target/release/snarkOS --rpc-username <Username> --rpc-password <Password>
```

#### How to manually connect to a peer on the network
```
./target/release/snarkOS --connect "<IP ADDRESS>"
```

### Interfacing with a running node

By default, snarkOS runs a JSON-RPC server to allow external interfacing with the Aleo network. Additional information can be found [here](aleo/documentation/autogen/testnet/rpc/rpc_server/00_configurations.md)


## 4. License

Expand Down
8 changes: 3 additions & 5 deletions snarkOS/display.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ pub fn render_init(config: &Config) -> String {
if config.miner.is_miner {
match AccountAddress::<Components>::from_str(&config.miner.miner_address) {
Ok(miner_address) => {
output += &format!("Your Aleo address is {}.\n\n", config.miner.miner_address)
output += &format!("Your Aleo address is {}.\n\n", miner_address)
.bold()
.to_string();
}
Expand All @@ -51,11 +51,9 @@ pub fn render_init(config: &Config) -> String {
i => format!("testnet{}", i),
};
if config.miner.is_miner {
output += &format!("Starting a full node on {}.\n\n", network).bold().to_string();
output += &format!("Starting a mining node on {}.\n\n", network).bold().to_string();
} else {
output += &format!("Starting a light client node on {}.\n\n", network)
.bold()
.to_string();
output += &format!("Starting a client node on {}.\n\n", network).bold().to_string();
}

if config.rpc.json_rpc {
Expand Down

0 comments on commit 87d9993

Please sign in to comment.