Skip to content

Commit

Permalink
Documentation (EOS-Mainnet#39)
Browse files Browse the repository at this point in the history
* readme updates for dev portal

* hello world sample link
  • Loading branch information
porkchop authored Nov 22, 2019
1 parent feb83cd commit e766a65
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,5 @@ var/lib/node_*
.idea/
*.iws
.DS_Store
/.vs
/out/build/x64-Debug
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## Welcome to the WAX Source Code Repository!
This software enables businesses to rapidly build and deploy high-performance and high-security blockchain-based applications.
This software enables businesses to rapidly build and deploy high-performance and high-security blockchain-based applications. For developer tips and tutorials, refer to our [WAX Blockchain Developer Hive](https://developer.wax.io/).

The Worldwide Asset eXchange™ (WAX) is a purpose-built blockchain and protocol token designed to make e-commerce transactions faster, easier, and safer for all participants. The WAX Blockchain mainnet uses Delegated Proof of Stake (DPoS) as its consensus mechanism and is fully backward compatible with EOS. The custom features and incentive mechanisms developed by WAX are designed to optimize the blockchain’s usability in e-commerce, and encourage voting on guilds and proposals.

Expand All @@ -19,9 +19,13 @@ WAX is released under the open source MIT license and is offered “AS IS” wit

There is no public testnet running currently.
### Installation Instructions
You have 2 ways to run a node:

You have several ways to run a node and develop smart contracts on the WAX Blockchain:
1. Use our [production docker images](https://cloud.docker.com/u/waxteam/repository/docker/waxteam/production). This is the official and recommended way, also the faster one, you can run a node in seconds. See the [mainnet sample](https://github.com/worldwide-asset-exchange/wax-blockchain/tree/develop/samples/mainnet) for more information.
2. Currently, we are not providing pre-compiled packages. Therefore, you will have to compile the source code and install it with the following instructions:
2. Complete our [Docker Quickstart](https://developer.wax.io/dapps/docker-quickstart/). You can also find WAX tutorials in the [dApp Development](https://developer.wax.io/dapps/) section of the [WAX Blockchain Developer Hive](https://developer.wax.io/).
3. Currently, we are not providing pre-compiled packages. Therefore, if you can't use our Docker images, you will have to compile the source code and install it with the following instructions:

**Note:** Building from source is not supported. We recommend using our [Docker Images](https://hub.docker.com/u/waxteam) instead.

```console

Expand Down Expand Up @@ -60,6 +64,7 @@ WAX currently supports the following operating systems:
### Resources
- [Website](https://wax.io)
- [Blog](https://wax.io/blog)
- [WAX Blockchain Developer Hive](https://developer.wax.io/)
- [Community Telegram Group](https://t.me/wax_io)
- [White Paper](https://wax.io/uploads/WAX_White_Paper.pdf)

Expand Down
2 changes: 1 addition & 1 deletion samples/hello-world/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Hello World sample

## The idea of this sample is to show how to build and deploy a simple smart contract project.
## The idea of this sample is to show how to build and deploy a simple smart contract project. For more information and tips on customizing these scripts, refer to [Docker Deploy](https://developer.wax.io/dapps/docker-deploy/) on the WAX Developer Hive.

### Requirements
- docker, installed and configured to run without sudo
Expand Down

0 comments on commit e766a65

Please sign in to comment.