Skip to content

Commit 92c1620

Browse files
authored
Revise README to include links to docs for better guidance (#128)
* Replace docs site link with links to multiple docs * Add link to overview doc under intro paragraph * Apply suggestions from code review [skip ci] * Update README.md * Add links to design and implementation docs
1 parent d04c051 commit 92c1620

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,22 @@
22

33
ScalarDL is a scalable and practical Byzantine fault detection middleware for transactional database systems that achieves correctness, scalability, and database agnosticism.
44

5-
## Docs
6-
* [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/)
7-
* [ScalarDL Technical Overview](https://speakerdeck.com/scalar/scalar-dl-technical-overview)
8-
* [ScalarDL Research Paper](https://dl.acm.org/doi/abs/10.14778/3523210.3523212) [VLDB'22]
5+
To learn more, see [ScalarDL Overview](https://scalardl.scalar-labs.com/docs/latest/overview).
6+
7+
## Quickstart
8+
9+
1. Start running contracts.
10+
- **Get started with ScalarDL Ledger:** To set up a basic application and run contracts by using ScalarDL Ledger, see [Get Started with ScalarDL Ledger](https://scalardl.scalar-labs.com/docs/latest/getting-started).
11+
- **Get started with ScalarDL Auditor (for enterprise customers):** To set up a basic application and run contracts by using ScalarDL Ledger and then use ScalarDL Auditor to detect whether those contracts have been tampered with, see [Getting Started with ScalarDL Auditor](https://scalardl.scalar-labs.com/docs/latest/getting-started-auditor).
12+
2. See how to set up a [simple bank account application that uses ScalarDL](https://scalardl.scalar-labs.com/docs/latest/applications/simple-bank-account).
13+
3. Learn about the [configurations for ScalarDL](https://scalardl.scalar-labs.com/docs/latest/configurations)
14+
4. Learn about ScalarDL and its features:
15+
- [ScalarDL design](https://scalardl.scalar-labs.com/docs/latest/design)
16+
- [ScalarDL implementation](https://scalardl.scalar-labs.com/docs/latest/implementation)
17+
- [Authentication](https://scalardl.scalar-labs.com/docs/latest/authentication)
18+
- [Generic contracts](https://scalardl.scalar-labs.com/docs/latest/use-generic-contracts)
19+
20+
For additional documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest).
921

1022
## Contributing
1123
ScalarDL is mainly maintained by the Scalar Engineering Team, but of course we appreciate any help.

0 commit comments

Comments
 (0)