Skip to content

docs: update readme and script names#4

Merged
remcostoeten merged 1 commit into
masterfrom
chore/naming
Sep 18, 2025
Merged

docs: update readme and script names#4
remcostoeten merged 1 commit into
masterfrom
chore/naming

Conversation

@remcostoeten

@remcostoeten remcostoeten commented Sep 18, 2025

Copy link
Copy Markdown
Owner

Summary by CodeRabbit

  • Documentation

    • Revamped README with Drizzleasy branding, quick start, installation, features, and comprehensive usage guides.
    • Added database support examples (PostgreSQL, SQLite, Turso), environment switching, CRUD operations, auto-detection, WHERE syntax, and error handling sections.
    • Included module compatibility notes (ESM/CommonJS), visual demo, and badges; retained Contributing and License.
  • Chores

    • Updated the gemini script to use the new CLI entrypoint for streamlined tooling.

@remcostoeten remcostoeten merged commit e6ed980 into master Sep 18, 2025
1 of 2 checks passed
@coderabbitai

coderabbitai Bot commented Sep 18, 2025

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

Walkthrough

README.md was completely rewritten to a product-focused guide with examples, features, usage, and installation. package.json updated the gemini script to call scripts/gemini-cli instead of scripts/gemini.py. No source code or APIs changed.

Changes

Cohort / File(s) Summary
Documentation
README.md
Replaced historical notes with a comprehensive, branding-oriented README: quick example, installation, database support (PostgreSQL/SQLite/Turso), CRUD patterns, initialization, environment switching, WHERE syntax, module support, error handling, badges, and demo reference.
Build/Tooling
package.json
Updated scripts: gemini now runs python3 scripts/gemini-cli (was python3 scripts/gemini.py). No dependency or other script changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I thump my paws—new docs unfurl,
A README fresh as morning whirl.
One hop to gemini’s new door,
CLI path—no py no more.
Type-safe fields in gardens green,
I nibble queries, crisp and clean.
Ship it swift—ears up, code keen!


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between 3f9cd90 and f715557.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • package.json (1 hunks)

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

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

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