docs: update installation and root level readme (#164)#165
Conversation
* docs: update pixelpass installation guide Signed-off-by: KiruthikaJeyashankar <kiruthikavjshankar@gmail.com> * docs: root readme udpate Signed-off-by: KiruthikaJeyashankar <kiruthikavjshankar@gmail.com> --------- Signed-off-by: KiruthikaJeyashankar <kiruthikavjshankar@gmail.com>
WalkthroughThis PR updates documentation only. README.md gains an "Available Libraries" section linking to Kotlin, JavaScript, and Swift libraries. kotlin/Readme.md is updated to describe two separate Maven artifacts (pixelpass-aar, pixelpass-jar) with a new version 1.0.0-alpha.1, replacing the previous single artifact instructions. ChangesDocumentation updates
Estimated code review effort: 1 (Trivial) | ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@kotlin/Readme.md`:
- Around line 12-53: The README install coordinates are using a newer release
version than the Kotlin publishing default, so the documented artifacts may not
resolve. Update the version reference in kotlin/Readme.md to match the version
emitted by the publishing flow, and verify it stays consistent with the default
in PixelPass/publish-artifact.gradle (or ensure that script always overrides it
during release). Keep the artifact names pixelpass-aar and pixelpass-jar
unchanged while aligning the shared version string.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 1d9460c3-ce75-4726-a481-1000d46f71b5
📒 Files selected for processing (2)
README.mdkotlin/Readme.md
Summary by CodeRabbit