Skip to content

Commit 8f42e6d

Browse files
feeblefakiejosh-wongkomamitsu
authored
Backport to branch(3) : Add link to ScalarDB design doc in README (#2657)
Co-authored-by: Josh Wong <[email protected]> Co-authored-by: Mitsunori Komatsu <[email protected]>
1 parent 6c4e77b commit 8f42e6d

File tree

1 file changed

+27
-10
lines changed

1 file changed

+27
-10
lines changed

README.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,29 @@
55
---
66

77
## What is ScalarDB?
8-
ScalarDB is a cross-database HTAP engine. It achieves ACID transactions and real-time analytics across diverse databases to simplify the complexity of managing multiple databases.
8+
ScalarDB is a universal HTAP engine. It achieves ACID transactions and real-time analytics across diverse databases to simplify the complexity of managing multiple databases.
99

1010
<p align="center">
1111
<a href='https://www.youtube.com/watch?v=lW6nCEJV-gs' target="_blank"><img src='docs/images/scalardb-video-preview.png' width='70%'></a>
1212
</p>
1313

14-
## Docs
14+
To learn more, see [ScalarDB Overview](https://scalardb.scalar-labs.com/docs/latest/overview).
1515

16-
See our [User Documentation](https://scalardb.scalar-labs.com/docs/latest/).
16+
## Quickstart
17+
18+
1. Start running transactions.
19+
- **Get started with ScalarDB Core:** To set up a basic application by using Java, see [Getting Started with ScalarDB](https://scalardb.scalar-labs.com/docs/latest/getting-started-with-scalardb).
20+
- **Get started with ScalarDB Cluster (for enterprise customers):** To set up a basic application that uses ScalarDB Cluster through the Java API, see [Getting Started with ScalarDB Cluster](https://scalardb.scalar-labs.com/docs/latest/scalardb-cluster/getting-started-with-scalardb-cluster).
21+
2. To set up and run various samples instances, see the [list of ScalarDB sample applications](https://scalardb.scalar-labs.com/docs/latest/scalardb-samples).
22+
3. Learn about the [configurations for ScalarDB Core](https://scalardb.scalar-labs.com/docs/latest/configurations) and the [configurations for ScalarDB Cluster](https://scalardb.scalar-labs.com/docs/latest/scalardb-cluster/scalardb-cluster-configurations).
23+
4. Learn about ScalarDB and its features:
24+
- [ScalarDB design](https://scalardb.scalar-labs.com/docs/latest/design)
25+
- [User authentication/authorization](https://scalardb.scalar-labs.com/docs/latest/scalardb-cluster/scalardb-auth-with-sql) (for enterprise customers)
26+
- [Attribute-based access control](https://scalardb.scalar-labs.com/docs/latest/scalardb-cluster/authorize-with-abac) (for enterprise customers)
27+
- [Vector search](https://scalardb.scalar-labs.com/docs/latest/scalardb-cluster/getting-started-with-vector-search) (for enterprise customers)
28+
- For a comprehensive list of features, see [ScalarDB Features](https://scalardb.scalar-labs.com/docs/latest/features).
29+
30+
For additional documentation, visit [ScalarDB Documentation](https://scalardb.scalar-labs.com/docs/latest).
1731

1832
## Install
1933

@@ -43,12 +57,6 @@ This library is mainly maintained by the Scalar Engineering Team, but of course
4357
* For asking questions, finding answers and helping other users, please go to [stackoverflow](https://stackoverflow.com/) and use [scalardb](https://stackoverflow.com/questions/tagged/scalardb) tag.
4458
* For filing bugs, suggesting improvements, or requesting new features, help us out by opening an issue.
4559

46-
Here are the contributors we are especially thankful for:
47-
- [Toshihiro Suzuki](https://github.com/brfrn169) - created [Phoenix adapter](https://github.com/scalar-labs/scalardb-phoenix) for ScalarDB
48-
- [Yonezawa-T2](https://github.com/Yonezawa-T2) - reported bugs around Serializable and proposed a new Serializable strategy (now named Extra-Read)
49-
50-
## Development
51-
5260
### Pre-commit hook
5361

5462
This project uses [pre-commit](https://pre-commit.com/) to automate code format and so on as much as possible. If you're interested in the development of ScalarDB, please [install pre-commit](https://pre-commit.com/#installation) and the git hook script as follows.
@@ -61,9 +69,18 @@ $ pre-commit install
6169

6270
The code formatter is automatically executed when committing files. A commit will fail and be formatted by the formatter when any invalid code format is detected. Try to commit the change again.
6371

72+
### Exception and log message guidelines
73+
74+
All the exception and log messages in this project are consistent with the following guidelines:
75+
76+
- The first character is capitalized.
77+
- The message does not end with a punctuation mark.
78+
79+
When contributing to this project, please follow these guidelines.
80+
6481
## License
6582

6683
ScalarDB is dual-licensed under both the Apache 2.0 License (found in the LICENSE file in the root directory) and a commercial license.
6784
You may select, at your option, one of the above-listed licenses.
6885
The commercial license includes several enterprise-grade features such as ScalarDB Cluster, management tools, and declarative query interfaces like GraphQL and SQL interfaces.
69-
For more information about the commercial license, please [contact us](https://www.scalar-labs.com/contact).
86+
For more information about the commercial license, please [contact us](https://www.scalar-labs.com/contact).

0 commit comments

Comments
 (0)