Skip to content

docs: update installation and root level readme#164

Merged
swatigoel merged 2 commits into
inji:release-1.0.xfrom
tw-mosip:update-docs
Jul 9, 2026
Merged

docs: update installation and root level readme#164
swatigoel merged 2 commits into
inji:release-1.0.xfrom
tw-mosip:update-docs

Conversation

@KiruthikaJeyashankar

@KiruthikaJeyashankar KiruthikaJeyashankar commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Updated the main README with a new “Available Libraries” section covering Kotlin, JavaScript, and Swift options with direct links.
    • Refreshed the Kotlin usage guide to show separate Android and JVM package options and updated dependency examples to the latest release version.

Signed-off-by: KiruthikaJeyashankar <kiruthikavjshankar@gmail.com>
Signed-off-by: KiruthikaJeyashankar <kiruthikavjshankar@gmail.com>
@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ef6811e3-3a47-4b3e-8e9e-733f51f4904f

📥 Commits

Reviewing files that changed from the base of the PR and between c1b897f and 361a2ac.

📒 Files selected for processing (2)
  • README.md
  • kotlin/Readme.md

Walkthrough

This PR updates documentation only. The top-level README gains an "Available Libraries" section listing Kotlin, JavaScript, and Swift resources. The Kotlin README's usage instructions are updated to reference two separate artifacts, pixelpass-aar and pixelpass-jar, at version 1.0.0-alpha.1.

Changes

Documentation updates

Layer / File(s) Summary
Available Libraries section
README.md
Added a new section describing Kotlin, JavaScript, and Swift library resources with links.
Kotlin artifact usage docs
kotlin/Readme.md
Replaced single-artifact usage instructions with separate pixelpass-aar and pixelpass-jar Gradle and Maven examples at version 1.0.0-alpha.1, removing the prior 0.8.0-RC1 combined artifact instructions.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Poem

A rabbit hops through docs anew,
Two artifacts now, not one but two! 🐇
AAR for Android, JAR for JVM,
README links point to each of them.
Hop, hop, alpha.1 — versions on track!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the docs-only changes to the root README and Kotlin installation/usage instructions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

@swatigoel swatigoel merged commit b199616 into inji:release-1.0.x Jul 9, 2026
5 checks passed
swatigoel pushed a commit that referenced this pull request Jul 9, 2026
* docs: update pixelpass installation guide



* docs: root readme udpate



---------

Signed-off-by: KiruthikaJeyashankar <kiruthikavjshankar@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants