Add readmes and license

[k0d13]

Summary by CodeRabbit

• Documentation

  • Added new README files for the main project, website, browser extension, Discord bot, and all packages, providing descriptions and usage information.
  • Updated or added detailed JSDoc comments across multiple packages and scripts for improved clarity.
  • Added a new license file specifying the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.

• Chores

  • Added or updated "description" fields in all package metadata files for better project documentation.
  • Removed an obsolete CLI script from the scripts package.
  • Cleaned up legacy commented-out CSS for Tailwind 3.x compatibility.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
evaluate	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 16, 2025 4:30am

[coderabbitai]

Walkthrough

This update introduces or refines project metadata and documentation across all major packages and applications. Description fields were added to multiple package.json files, new README files were created for each project and package, and license information was formalized. Several source files received improved JSDoc comments, clarifying function and class purposes, parameters, and return values. One deprecated CLI script was removed, and legacy CSS was cleaned up.

Changes

Files/Groups	Change Summary
apps/browser-extension/package.json, apps/discord-bot/package.json, apps/website/package.json	Added "description" field describing each app's functionality.
apps/browser-extension/readme.md, apps/discord-bot/readme.md, apps/website/readme.md	Added new README files introducing each application and its features.
license.txt	Added Creative Commons license file.
packages/components/package.json, packages/engine/package.json, packages/helpers/package.json, packages/hooks/package.json, packages/scripts/package.json, packages/shapes/package.json, packages/styles/package.json	Added or updated "description" field; removed "version" fields where present.
packages/components/readme.md, packages/engine/readme.md, packages/helpers/readme.md, packages/hooks/readme.md, packages/scripts/readme.md, packages/shapes/readme.md, packages/styles/readme.md	Added new README files describing each package.
packages/engine/src/compress/index.ts, packages/engine/src/execute/arguments.ts, packages/engine/src/runtimes/fetch.ts, packages/engine/src/runtimes/getters.ts, packages/engine/src/runtimes/identifier.ts	Improved JSDoc comments for clarity and conciseness.
packages/engine/src/execute/fetch.ts	Added explicit parameter and return types to executeCode and refined JSDoc.
packages/helpers/src/better-fetch/better-fetch.ts, packages/helpers/src/better-fetch/http-error.ts, packages/helpers/src/create-logger/create-logger.ts, packages/helpers/src/create-logger/hex-to-ansi.ts	Added or improved JSDoc comments; introduced LoggerOptions interface and updated related function signature.
packages/hooks/src/event-callback.ts, packages/hooks/src/event-listener.ts, packages/hooks/src/isomorphic-layout-effect.ts	Added source attribution comments at file top.
packages/hooks/src/media-query.ts	Renamed breakpoints to TAILWIND_BREAKPOINTS, updated types, and added JSDoc to useMediaQuery.
packages/scripts/bin/ff-zip, packages/scripts/bin/use-env	Added JSDoc blocks describing each script's usage and functionality.
packages/scripts/bin/run-in	Removed deprecated CLI script.
packages/styles/src/styles.css	Removed legacy commented-out Tailwind v3 CSS compatibility block.
readme.md	Added project-level README with banner, navigation, and overview.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docs
    participant Package

    User->>Docs: Reads new README for overview and usage
    User->>Package: Checks package.json for description or license
    Docs-->>User: Provides features and integration info
    Package-->>User: Shows metadata for discoverability

Loading

Poem

In the warren, docs now bloom,
With descriptions clear, dispelling gloom.
JSDoc carrots line the code,
While README tales are widely showed.
Old scripts burrowed, CSS cleaned,
Now Evaluate shines, well-described and 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 df79448 and 09fc21c.

⛔ Files ignored due to path filters (1)

• .github/banner.png is excluded by !**/*.png

📒 Files selected for processing (40)

• apps/browser-extension/package.json (1 hunks)
• apps/browser-extension/readme.md (1 hunks)
• apps/discord-bot/package.json (1 hunks)
• apps/discord-bot/readme.md (1 hunks)
• apps/website/package.json (1 hunks)
• apps/website/readme.md (1 hunks)
• license.txt (1 hunks)
• packages/components/package.json (1 hunks)
• packages/components/readme.md (1 hunks)
• packages/engine/package.json (1 hunks)
• packages/engine/readme.md (1 hunks)
• packages/engine/src/compress/index.ts (2 hunks)
• packages/engine/src/execute/arguments.ts (1 hunks)
• packages/engine/src/execute/fetch.ts (1 hunks)
• packages/engine/src/runtimes/fetch.ts (1 hunks)
• packages/engine/src/runtimes/getters.ts (9 hunks)
• packages/engine/src/runtimes/identifier.ts (2 hunks)
• packages/helpers/package.json (1 hunks)
• packages/helpers/readme.md (1 hunks)
• packages/helpers/src/better-fetch/better-fetch.ts (1 hunks)
• packages/helpers/src/better-fetch/http-error.ts (2 hunks)
• packages/helpers/src/create-logger/create-logger.ts (2 hunks)
• packages/helpers/src/create-logger/hex-to-ansi.ts (2 hunks)
• packages/hooks/package.json (1 hunks)
• packages/hooks/readme.md (1 hunks)
• packages/hooks/src/event-callback.ts (1 hunks)
• packages/hooks/src/event-listener.ts (1 hunks)
• packages/hooks/src/isomorphic-layout-effect.ts (1 hunks)
• packages/hooks/src/media-query.ts (1 hunks)
• packages/scripts/bin/ff-zip (1 hunks)
• packages/scripts/bin/run-in (0 hunks)
• packages/scripts/bin/use-env (1 hunks)
• packages/scripts/package.json (1 hunks)
• packages/scripts/readme.md (1 hunks)
• packages/shapes/package.json (1 hunks)
• packages/shapes/readme.md (1 hunks)
• packages/styles/package.json (1 hunks)
• packages/styles/readme.md (1 hunks)
• packages/styles/src/styles.css (0 hunks)
• readme.md (1 hunks)

💤 Files with no reviewable changes (2)

• packages/styles/src/styles.css
• packages/scripts/bin/run-in

---

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.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.