Add API guide (#620)

scalar-labs · Jul 4, 2022 · 8398aa7 · 8398aa7
1 parent 1d46699
commit 8398aa7
Show file tree

Hide file tree

Showing 8 changed files with 746 additions and 116 deletions.
diff --git a/README.md b/README.md
@@ -28,6 +28,7 @@ To add a dependency using Maven:
 
 ## Docs
 * [Getting started](docs/getting-started.md)
+* [Java API Guide](docs/api-guide.md)
 * [Scalar DB supported databases](docs/scalardb-supported-databases.md)
 * [Multi-storage Transactions](docs/multi-storage-transactions.md)
 * [Two-phase Commit Transactions](docs/two-phase-commit-transactions.md)

diff --git a/core/src/main/java/com/scalar/db/api/TransactionCrudOperable.java b/core/src/main/java/com/scalar/db/api/TransactionCrudOperable.java
@@ -6,9 +6,9 @@
 import java.util.Optional;
 
 /**
- * An interface for transaction CRUD operations. Note that LINEARIZABLE consistency is always used
- * in transactional CRUD operations, so {@link Consistency} specified for CRUD operations is
- * ignored.
+ * An interface for transaction CRUD operations. Note that the LINEARIZABLE consistency level is
+ * always used in transactional CRUD operations, so {@link Consistency} specified for CRUD
+ * operations is ignored.
  */
 public interface TransactionCrudOperable {