📝 Improve README on npm

[lambdalisue]

Summary by CodeRabbit

• Documentation
  • Updated the README to refine the installation instructions and usage guidelines for the unknownutil package.
• Chores
  • Implemented a post-build step to automate README updates for npm distributions.

[coderabbitai]

Walkthrough

The project's documentation and build process have been updated to remove references to the unknownutil package for Node.js users. The README no longer includes npm instructions or import examples for this package. Additionally, a post-build step has been introduced to the npm build script to automatically adjust the README for npm distribution, including the addition of new installation instructions.

Changes

File Path	Change Summary
README.md	Removed Node.js npm usage instructions for unknownutil
scripts/build_npm.ts	Added post-build step to modify npm README content

Poem

🐰 "A change in the code, a hop and a skip,
📦 No more npm, a part of our trip.
📝 README adjusts with a build-script flip,
🌟 A new path we tread, let's not slip!"

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit's AI:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• 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 generate unit tests for this file.
  • @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 generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (81e450d) 99.49% compared to head (73de421) 99.49%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #46   +/-   ##
=======================================
  Coverage   99.49%   99.49%           
=======================================
  Files           3        3           
  Lines         393      393           
  Branches       35       35           
=======================================
  Hits          391      391           
  Misses          2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 81e450d and 73de421.

Files selected for processing (2)

• README.md (1 hunks)
• scripts/build_npm.ts (1 hunks)

Files skipped from review due to trivial changes (2)

• README.md
• scripts/build_npm.ts