Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md for clarity #2002

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Read our [whitepapers](https://www.kadena.io/whitepapers):
- [Chainweb: A Proof-of-Work Parallel-Chain Architecture for Massive Throughput](https://d31d887a-c1e0-47c2-aa51-c69f9f998b07.filesusr.com/ugd/86a16f_029c9991469e4565a7c334dd716345f4.pdf)
- [Agent-based Simulations of Blockchain Protocols illustrated via Kadena's *Chainweb*](https://d31d887a-c1e0-47c2-aa51-c69f9f998b07.filesusr.com/ugd/86a16f_3b2d0c58179d4edd9df6df4d55d61dda.pdf)

For additional information, press, and development inquires, please refer to the Kadena [website](https://kadena.io)
For additional information, press, and development inquiries, please refer to the Kadena [website](https://kadena.io)

## Table of Contents

Expand Down Expand Up @@ -44,7 +44,7 @@ Minimal recommended hardware requirements for nodes are:
* 250 GB SSD or fast HDD
* Public IP address

If the node is also used as API server for Pact or mining, rosetta, chainweb-data: 4 CPU cores and 8GB of RAM.
If the node is also used as API server for Pact or mining, Rosetta, chainweb-data: 4 CPU cores and 8GB of RAM.

### Docker (all batteries included)

Expand Down Expand Up @@ -103,7 +103,7 @@ At this point, you are ready to [run a Chainweb node](#configuring-running-and-m

## Building from Source

*IMPORTANT NODE: We recommend the use of officially released chainweb-node
*IMPORTANT NOTE: We recommend the use of officially released chainweb-node
binaries or docker images, which can be found in the
[release section of this
repository](https://github.com/kadena-io/chainweb-node/releases).
Expand Down Expand Up @@ -243,7 +243,7 @@ are disabled by default (e.g. mining API, Rosetta, and header updates).
While the P2P endpoint must be directly available from the public internet, it
is highly recommended to expose the service API only on a private network. When
service API endpoints are made available publicly it is recommended to use a
reverse proxy setup things like rate limiting, authentication, and CORS.
reverse proxy setup such as rate limiting, authentication, and CORS.

### Configuration

Expand Down