docs: sync README with latest SDK API

[gunoooo]

배경

reset() API 추가 및 removeUserId() deprecated에 따라 README를 최신 SDK API에 맞게 동기화합니다.

변경 사항

Installation

• 의존성 버전 1.3.2 → 1.5.0으로 업데이트 (최신 릴리즈 반영)

User Management

• deprecated된 removeUserId() 예제를 User Management 섹션에서 제거

Reset 섹션 추가

• Clix.reset() 사용법과 설명 추가 (새 device ID 생성, user ID 제거, session 데이터 초기화)
• reset() 호출 후 반드시 initialize()를 다시 호출해야 한다는 안내 포함

Summary by CodeRabbit

• Documentation

  • Updated User Management API documentation with new Clix.reset() method
  • Added Reset functionality documentation covering behavioral impact (local state clearing, new device ID generation) and post-reset re-initialization requirements

• Chores

  • Updated SDK dependency version

[coderabbitai]

Walkthrough

The README.md was updated to document SDK version upgrade from 1.3.2 to 1.5.0, reflecting API changes where the Clix.removeUserId() method is replaced with Clix.reset() in user management workflows, along with new documentation detailing reset behavior and post-reset initialization requirements.

Changes

Cohort / File(s)	Summary
Documentation Updates README.md	Updated SDK version dependency (1.3.2 → 1.5.0), replaced Clix.removeUserId() with Clix.reset() in User Management flow, added new Reset section documenting behavioral impact (state clearing, device ID regeneration), and re-initialization requirement.

Possibly related PRs

• feat: add reset() and deprecate removeUserId() #23: Implements the reset() method and deprecates removeUserId() in the SDK, directly corresponding to the API-level changes documented in this PR.

Suggested reviewers

• nyanxyz
• pitzcarraldo

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: sync README with latest SDK API' directly and clearly describes the main change—updating documentation to reflect SDK API changes (new reset() API and deprecation of removeUserId()).
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch sync-readme

---

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

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 680cc69150

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

[coderabbitai]

🧹 Nitpick comments (1)

README.md (1)

93-104: Consider clarifying backend implications of reset().

The reset() documentation accurately describes the local behavior, but it might be helpful to explicitly mention that previous device records on the backend are orphaned (not deleted) when a new device ID is generated. This could help users understand the complete impact, especially in scenarios where they need to manage user data or analytics continuity.

📝 Optional documentation enhancement

Consider adding a note about backend implications:

-Use `reset()` when you need a completely fresh device identity (e.g., shared device scenarios). This clears all local SDK state and generates a new device ID on next initialization.
+Use `reset()` when you need a completely fresh device identity (e.g., shared device scenarios). This clears all local SDK state and generates a new device ID on next initialization. Note that previous device records on the backend are orphaned rather than deleted.

Based on learnings: In the Clix Android SDK, after reset() + initialize(), a new device ID is generated and old backend records are intentionally orphaned rather than explicitly deleted via API calls.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 93 - 104, Update the "Reset" section to explicitly
state that calling reset() clears local SDK state and generates a new device ID
on next initialize(), and that any previous device records on the backend are
not deleted but become orphaned (i.e., previous backend records remain
associated with the old device ID); reference the reset() and initialize()
methods in the note so readers understand the lifecycle and backend implication
when managing user data or analytics continuity.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Around line 93-104: Update the "Reset" section to explicitly state that
calling reset() clears local SDK state and generates a new device ID on next
initialize(), and that any previous device records on the backend are not
deleted but become orphaned (i.e., previous backend records remain associated
with the old device ID); reference the reset() and initialize() methods in the
note so readers understand the lifecycle and backend implication when managing
user data or analytics continuity.

[gunoooo]

coderabbit nitpick 관련: 백엔드에서 이전 디바이스 레코드가 orphan된다는 내용은 SDK 사용자에게 필요한 정보가 아니라 내부 구현 세부사항이므로 README에는 포함하지 않습니다. reset()의 로컬 동작만 문서화하는 것이 적절합니다.