docs: add README.md

[BlackHole1]

No description provided.

[coderabbitai]

Summary by CodeRabbit

• Documentation
  • Added comprehensive SDK documentation with installation instructions, quick start guide, and API reference for core operations (GetRow, PutRow, UpdateRow, DeleteRow, BatchGetRow, BatchWriteRow, GetRange)
  • Included examples for advanced features including filters, conditions, transactions, and return content handling with TypeScript code samples

Walkthrough

A README.md file has been added providing comprehensive documentation for the Alibaba Cloud TableStore SDK. The documentation includes installation instructions, quick start examples, and an API reference covering core CRUD operations (GetRow, PutRow, UpdateRow, DeleteRow), batch operations (BatchGetRow, BatchWriteRow), range queries (GetRange), helper functions (createPrimaryKey, createAttribute), and advanced features (Filters, Conditions, Transactions, Return Content). Code samples demonstrate client initialization and operation patterns in TypeScript.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Code example verification: Ensure all TypeScript examples accurately reflect the actual SDK API and match supported parameters
• API reference completeness: Verify that all documented operations, parameters, and response structures are current and accurate
• Feature coverage: Confirm that advanced features like Filters, Conditions, and Transactions are properly described and match implementation
• Documentation consistency: Check for inconsistencies between code examples and prose descriptions throughout the document

Pre-merge checks

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The pull request title "docs: add README.md" follows the required format <type>(<scope>): <subject> with "docs" as the type and "add README.md" as the subject, with the optional scope omitted. The title is fully related to the main change in the changeset, as the raw summary confirms the PR adds a comprehensive README.md file for the Alibaba Cloud TableStore SDK. The title is written in English as required. The title clearly and accurately summarizes the primary change being introduced.
Description Check	✅ Passed	No pull request description was provided by the author. While the description is absent rather than explicitly written, it does not contain content that is completely off-topic or unrelated to the changeset. Given that the check is described as very lenient and should pass as long as the description is not completely off-topic, the absence of a description does not violate this criterion. The lack of a description, while not ideal for documentation purposes, does not fail the lenient requirements of this check.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull Request Overview

This PR adds a comprehensive README.md file for the Alibaba Cloud TableStore SDK, providing documentation for a TypeScript-native SDK implementation.

• Complete SDK documentation with installation instructions, quick start guide, and API reference
• Detailed examples for all major operations (GetRow, PutRow, UpdateRow, DeleteRow, BatchGetRow, BatchWriteRow, GetRange)
• Documentation of helper functions and advanced features including filters, conditions, transactions, and return content control

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

1-320: Well-structured documentation with two verification needs.

The README provides comprehensive API documentation, clear examples, and good organization. However, before merging, please verify:

1. GetRange API consistency (lines 201-202): Confirm whether primary key parameters accept unwrapped values or if they should be arrays like in other examples.
2. Sub-path import (line 259): Verify that "alicloud-tablestore/builder/filter" is the correct export path in the SDK.

Optional improvements (not blockers):

• Add error handling patterns to examples
• Document connection configuration, timeouts, and retry behavior
• Provide pagination guidance for large GetRange results
• Show response error handling

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a0a638a and 59efa5b.

📒 Files selected for processing (1)

• README.md (1 hunks)

🔇 Additional comments (4)

README.md (4)

1-50: Clear installation and onboarding guidance.

The quick start section effectively demonstrates the basic workflow with sensible defaults and clear example patterns. Good use of placeholder credentials.

---

190-208: Verify GetRange primary key parameter format.

Line 201-202 shows createPrimaryKey() being used directly for inclusiveStartPrimaryKey and exclusiveEndPrimaryKey, but other examples (lines 31, 45, 66, 84, etc.) wrap primary keys in arrays. Please confirm whether GetRange accepts unwrapped values or if this example needs correction for consistency.

---

259-268: Verify sub-path import availability.

Line 259 shows an import from "alicloud-tablestore/builder/filter". Please confirm this sub-path export is available in the SDK; users following this documentation will encounter import errors if this path is incorrect or if the module uses a different export structure.

---

252-316: Advanced features documentation is comprehensive.

The examples for Filters, Conditions, Transactions, and Return Content are well-structured and demonstrate the API clearly. The use of enums (ComparatorType, RowExistenceExpectation, ReturnType) is appropriately shown.