-
Notifications
You must be signed in to change notification settings - Fork 138
mdlint and vale editorial updates - index.md #169
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
Merged
MadelineMurray
merged 16 commits into
besu-eth:master
from
grantnoble:grantnoble-index-mdlint-vale
Feb 20, 2020
Merged
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
d3a30ca
Moved license note (#129)
MadelineMurray 07e37cd
Windows is now supported in the quickstart (#143)
EdJoJob e344dd1
quickstart updates all round (#141)
joshuafernandes 85dc1af
Fixed typo (#150)
MadelineMurray fdbb599
Add multi-tenancy information. (#131)
bgravenorst 8d8a390
Apply renames for the quickstart repo (#152)
EdJoJob 9816738
Added content on protocol upgrades (#132)
MadelineMurray a66d9b0
Fixed Ansible link and renamed topic (#168)
MadelineMurray c0aff4e
mdline and vale editorial updates
ff9ecf8
4 spaces added to the beginning of the description wrapped text
4266897
Merge branch 'master' into grantnoble-index-mdlint-vale
ad23497
Merge branch 'master' into grantnoble-index-mdlint-vale
0703a0e
reinstated contraction
fe21b0d
Merge branch 'master' into grantnoble-index-mdlint-vale
351d1f9
Merge branch 'master' into grantnoble-index-mdlint-vale
598573c
Merge branch 'master' into grantnoble-index-mdlint-vale
MadelineMurray File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,41 @@ | ||
| title: Hyperledger Besu Enterprise Ethereum Client | ||
| description: Besu is an open-source Enterprise Ethereum client developed under the Apache 2.0 license and written in Java. It runs on the Ethereum public network, private networks, and test networks. | ||
| description: Besu is an open-source Enterprise Ethereum client developed under the Apache 2.0 | ||
| license and written in Java. It runs on the Ethereum public network, private networks, and test | ||
| networks. | ||
| <!--- END of page meta data --> | ||
|
|
||
| # Besu Enterprise Ethereum Client | ||
|
|
||
| ## What is Hyperledger Besu? | ||
|
|
||
| Hyperledger Besu is an open-source Ethereum client developed under the Apache 2.0 license and written in Java. | ||
| It runs on the Ethereum public network, private networks, and test networks such as Rinkeby, Ropsten, | ||
| and Görli. Besu implements Proof of Work (Ethash) and Proof of Authority (IBFT 2.0 and Clique) consensus | ||
| mechanisms. | ||
| Hyperledger Besu is an open-source Ethereum client developed under the Apache 2.0 license and | ||
| written in Java. It runs on the Ethereum public network, private networks, and test networks such | ||
| as Rinkeby, Ropsten, and Görli. Besu implements Proof of Work (Ethash) and Proof of Authority (IBFT | ||
| 2.0 and Clique) consensus mechanisms. | ||
|
|
||
| You can use Besu to develop enterprise applications requiring secure, high-performance transaction | ||
| processing in a private network. | ||
| You can use Besu to develop enterprise applications requiring secure, high-performance transaction | ||
| processing in a private network. | ||
|
|
||
| Besu supports enterprise features including privacy and permissioning. | ||
| Besu supports enterprise features including privacy and permissioning. | ||
|
|
||
| ## What can you do with Besu? | ||
|
|
||
| Besu includes a [command line interface](Reference/CLI/CLI-Syntax.md) and [JSON-RPC API](HowTo/Interact/APIs/API.md) | ||
| for running, maintaining, debugging, and monitoring nodes in an Ethereum network. You can use the API via RPC | ||
| over HTTP or via WebSockets, and Pub/Sub is supported. The API supports typical Ethereum functionalities such as: | ||
| Besu includes a [command line interface](Reference/CLI/CLI-Syntax.md) and | ||
| [JSON-RPC API](HowTo/Interact/APIs/API.md) for running, maintaining, debugging, and monitoring | ||
| nodes in an Ethereum network. You can use the API via RPC over HTTP or via WebSockets. Besu also | ||
| supports Pub/Sub. The API supports typical Ethereum functionalities such as: | ||
|
|
||
| * Ether mining | ||
| * Smart contract development | ||
| * Decentralized application (Dapp) development | ||
| * Decentralized application (Dapp) development. | ||
|
|
||
| ## What does Besu support? | ||
|
|
||
| The Besu client supports common smart contract and Dapp development, deployment, and operational use cases, using tools such as [Truffle](http://truffleframework.com/), [Remix](https://github.com/ethereum/remix), and [web3j](https://web3j.io/). The client supports common JSON-RPC API methods such as eth, net, web3, debug, and miner. | ||
| The Besu client supports common smart contract and Dapp development, deployment, and operational | ||
| use cases, using tools such as [Truffle](http://truffleframework.com/), | ||
| [Remix](https://github.com/ethereum/remix), and [web3j](https://web3j.io/). The client supports | ||
| common JSON-RPC API methods such as eth, net, web3, debug, and miner. | ||
|
|
||
| Besu doesn't support [key management](HowTo/Send-Transactions/Account-Management.md) inside the client. You can use | ||
| [EthSigner](http://docs.ethsigner.pegasys.tech/en/latest/) with Besu to provide access to your key store | ||
| and sign transactions. | ||
| Besu doesn't support [key management](HowTo/Send-Transactions/Account-Management.md) inside the | ||
| client. You can use [EthSigner](http://docs.ethsigner.pegasys.tech/en/latest/) with Besu to access | ||
| your key store and sign transactions. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why a dot? Or maybe we should have a ; at the end of the previous items ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Period at the end of a bulleted list to indicate the end of the sentence.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Personally, I'm not a fan of ; at the end of bullet points. It depends on our style guide, but I advocate periods at the end of each point (if each point is its own sentence) or a period at the end of the list of items.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
; is against our style guide (I'm with you @grantnoble on that one) and yep, period on the end of each point if they're standalone or on the last one if they're a list.