You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-10Lines changed: 27 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,15 +5,29 @@
5
5
---
6
6
7
7
## 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.
To learn more, see [ScalarDB Overview](https://scalardb.scalar-labs.com/docs/latest/overview).
15
15
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).
- 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).
17
31
18
32
## Install
19
33
@@ -43,12 +57,6 @@ This library is mainly maintained by the Scalar Engineering Team, but of course
43
57
* 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.
44
58
* For filing bugs, suggesting improvements, or requesting new features, help us out by opening an issue.
45
59
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
-
52
60
### Pre-commit hook
53
61
54
62
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
61
69
62
70
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.
63
71
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
+
64
81
## License
65
82
66
83
ScalarDB is dual-licensed under both the Apache 2.0 License (found in the LICENSE file in the root directory) and a commercial license.
67
84
You may select, at your option, one of the above-listed licenses.
68
85
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