Skip to content

Commit

Permalink
improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
Ji Qiren committed Mar 14, 2024
1 parent 75f31fb commit 2b4d46f
Showing 1 changed file with 19 additions and 18 deletions.
37 changes: 19 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,35 @@
# IOST - A Scalable & Developer Friendly Blockchain
# IOST - A High-Performance, Developer-Friendly Blockchain

IOST is a smart contract platform focusing on performance and developer friendliness.
IOST is a smart contract platform designed with a strong emphasis on performance and developer experience. It provides a robust infrastructure for building complex blockchain applications with ease and efficiency.

# Features

1. The V8 JavaScript engine is integrated inside the blockchain, so you can use JavaScript to write smart contracts!
2. The blockchain is highly scalable with thousands of TPS. Meanwhile it still has a more decentralized consensus than DPoS.
3. 0.5 second block, 0.5 minute finality.
4. Free transactions. You can stake coins to get gas.
1. **V8 JavaScript Engine**: The V8 JavaScript engine is integrated directly into the blockchain, enabling developers to write smart contracts using JavaScript. This brings about a world of benefits as JavaScript is a universally known language, making the development process easier and quicker. Furthermore, the V8 engine, being Google Chrome's open-source JavaScript engine, is known for its speed, which translates into extremely efficient smart contract execution.

# Development
2. **High Scalability**: IOST blockchain delivers high throughput with thousands of transactions per second (TPS), making it suitable for large-scale applications. While maintaining this high scalability, it also employs a more decentralized consensus mechanism than DPoS (Delegated Proof of Stake), ensuring a balance between performance and decentralization.

### Environments
3. **Fast Block Times and Finality**: With a 0.5-second block time and 0.5-minute finality, developers can create responsive, real-time applications. This rapid finality ensures transactions are confirmed quickly, in less than a minute. This is a highly desirable feature for developers as it improves user experience by providing swift, secure transaction confirmations.

OS: Ubuntu 22.04 or later
Go: 1.20 or later
4. **Free Transactions**: IOST offers free transactions. Users can stake coins to acquire gas, eliminating the need for transaction fees and making the platform more user-friendly.

IOST node uses CGO V8 javascript engine, so only x64 is supported now.
# Development

### Deployment
### Environment Requirements

build local binary: `make build`
start a local devnet: `make debug`
build docker: `make image`
- OS: Ubuntu 22.04 or later
- Go: 1.20 or later

Please note that the IOST node utilizes the CGO V8 JavaScript engine and currently only supports the x64 architecture.

### Deployment

For documentation, please visit: [IOST Developer](https://developers.iost.io)
- Build a local binary: Run `make build`
- Start a local development network: Run `make debug`
- Build a Docker image: Run `make image`

Welcome to our [tech community at telegram](https://t.me/iostdev)
For comprehensive documentation, please visit: [IOST Developer](https://developers.iost.io)

Happy hacking!
Join our [tech community on Telegram](https://t.me/iostdev) for discussions, updates, and support.

Happy hacking! We look forward to seeing what you build on the IOST platform.

0 comments on commit 2b4d46f

Please sign in to comment.