Skip to content

Fix small inconsistencies of README examples#452

Open
oscar0urselli wants to merge 2 commits into
Permify:mainfrom
oscar0urselli:main
Open

Fix small inconsistencies of README examples#452
oscar0urselli wants to merge 2 commits into
Permify:mainfrom
oscar0urselli:main

Conversation

@oscar0urselli

@oscar0urselli oscar0urselli commented Jul 2, 2026

Copy link
Copy Markdown

I noticed that the examples of the README.md contains some small errors on how to use the library.
There are missing fields of the Config parameter when creating a client and the use of client.relationships() in place of client.data() .

Summary by CodeRabbit

  • Documentation
    • Updated code examples in README to reflect current client configuration options and correct API usage patterns for relationship management operations.

- Missing client config parameters
- Replace client.relationship() with client.data()
docs(readme): Fix small inconsistencies of README examples.
@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2224c8fa-f74e-4d94-9198-444d03891999

📥 Commits

Reviewing files that changed from the base of the PR and between e90f442 and 0ec7d12.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

Updated README.md code examples to standardize client initialization options, replacing cert: undefined with cert: null, adding explicit pk: null and certChain: null fields, removing a timeout field, and changing client.relationship to client.data in one example.

Changes

README code example updates

Layer / File(s) Summary
Client options and relationship writer update
README.md
Eight code examples (Initialize Client, Tenant Management, Schema Management, Relationship Management, Permission Checks, Streaming, Access Token Interceptor, Certs) updated to use cert: null, pk: null, certChain: null; timeout field removed from basic client snippet; relationship writer changed from client.relationship to client.data.

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

🚥 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 main change: fixing inconsistencies in README usage examples.
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.

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.

1 participant