Skip to content

Revise README to include links to docs for better guidance #128

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.

Sign up for GitHub

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
merged 5 commits into from
May 8, 2025
Merged

Revise README to include links to docs for better guidance #128

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0200efa
Replace docs site link with links to multiple docs
josh-wong Apr 24, 2025
26f6507
Add link to overview doc under intro paragraph
josh-wong Apr 24, 2025
e67972a
Apply suggestions from code review
josh-wong Apr 25, 2025
b9e8b04
Update README.md
josh-wong May 8, 2025
b107fe1
Add links to design and implementation docs
josh-wong May 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,22 @@

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

## Docs
* [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest/)
* [ScalarDL Technical Overview](https://speakerdeck.com/scalar/scalar-dl-technical-overview)
* [ScalarDL Research Paper](https://dl.acm.org/doi/abs/10.14778/3523210.3523212) [VLDB'22]
To learn more, see [ScalarDL Overview](https://scalardl.scalar-labs.com/docs/latest/overview).

## Quickstart

1. Start running contracts.
- **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).
- **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).
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).
3. Learn about the [configurations for ScalarDL](https://scalardl.scalar-labs.com/docs/latest/configurations)
4. Learn about ScalarDL and its features:
- [ScalarDL design](https://scalardl.scalar-labs.com/docs/latest/design)
- [ScalarDL implementation](https://scalardl.scalar-labs.com/docs/latest/implementation)
- [Authentication](https://scalardl.scalar-labs.com/docs/latest/authentication)
- [Generic contracts](https://scalardl.scalar-labs.com/docs/latest/use-generic-contracts)

For additional documentation, visit [ScalarDL Documentation](https://scalardl.scalar-labs.com/docs/latest).

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