Skip to content

Commit 20384fd

Browse files
docs: improve README with features, prerequisites and contribution guide (#3712)
- Add a "Key Features" section highlighting main advantages of Linera - Add explicit system prerequisites for the quickstart guide - Include a new "Contributing" section with basic guidelines Signed-off-by: Gengar <[email protected]>
1 parent bf6768e commit 20384fd

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,15 @@
1212
[Linera](https://linera.io) is a decentralized blockchain infrastructure designed for highly scalable,
1313
low-latency Web3 applications.
1414

15+
## Key Features
16+
17+
- **High Scalability**: Process thousands of transactions per second with sub-second confirmation times
18+
- **Microchain Architecture**: Each user operates their own chain, eliminating global bottlenecks
19+
- **Low Fees**: Efficient consensus mechanism keeps transaction costs minimal
20+
- **Developer Friendly**: Build applications using familiar Rust and WebAssembly tools
21+
22+
## Documentation
23+
1524
Visit our [developer page](https://linera.dev) and read our
1625
[whitepaper](https://linera.io/whitepaper) to learn more about the Linera protocol.
1726

@@ -65,6 +74,13 @@ from low to high levels in the dependency graph)
6574

6675
## Quickstart with the Linera CLI tool
6776

77+
### Prerequisites
78+
79+
- [Rust](https://www.rust-lang.org/tools/install) (version 1.70 or higher)
80+
- [Git](https://git-scm.com/downloads)
81+
- Approximately 2GB of free disk space
82+
- Linux or macOS (Windows users should use WSL2)
83+
6884
The following commands set up a local test network and run some transfers between the
6985
microchains owned by a single wallet.
7086

@@ -130,3 +146,15 @@ linera query-balance "$CHAIN2:$ACCOUNT2"
130146

131147
More complex examples may be found in our [developer manual](https://linera.dev) as well
132148
as the [example applications](./examples) in this repository.
149+
150+
## Contributing
151+
152+
We welcome contributions from the community! If you'd like to contribute to the Linera protocol:
153+
154+
1. Fork the repository
155+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
156+
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
157+
4. Push to the branch (`git push origin feature/amazing-feature`)
158+
5. Open a Pull Request
159+
160+
For detailed guidelines, see our [contribution guide](https://linera.dev/getting-started/contributing).

0 commit comments

Comments
 (0)