chore(ui-components): add README

[avivkeller]

This PR gives our @node-core/ui-components package a nice little README for npm

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Updated (UTC)
nodejs-org	Ready	Preview	Nov 19, 2025 9:37pm

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.27%. Comparing base (3bf2753) to head (a8b3f6a).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8356      +/-   ##
==========================================
- Coverage   76.78%   76.27%   -0.51%     
==========================================
  Files         118      118              
  Lines        9828     9903      +75     
  Branches      336      336              
==========================================
+ Hits         7546     7554       +8     
- Misses       2280     2347      +67     
  Partials        2        2              

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

[Copilot]

Pull Request Overview

This PR adds README documentation for the @node-core/ui-components npm package. The main README provides an overview of the package and its purpose, while a component-specific README documents the Orama Search components.

• Added a main README.md with package description, design references, and links
• Added a Search component README with usage examples
• Updated publish script to copy README to dist folder for npm publication
• Bumped package version from 1.3.0 to 1.4.0

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File	Description
packages/ui-components/README.md	New main README with package overview and external references
packages/ui-components/src/Common/Search/README.md	New component-specific README with usage examples for Orama Search
packages/ui-components/scripts/publish.mjs	Added copyFile import and logic to copy README to dist folder
packages/ui-components/package.json	Version bump from 1.3.0 to 1.4.0

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Corrected word usage from 'compromised' to 'comprised'. 'Compromised' means 'endangered or exposed to risk', while 'comprised' means 'composed or made up of'.

Suggested change

	This package is compromised of UI components for use in the Node.js website, documentation,
	This package is comprised of UI components for use in the Node.js website, documentation,

[Copilot]

The copyFile operation lacks error handling. If the README.md file doesn't exist or the copy fails, the publish process will crash without a clear error message. Consider adding try-catch or checking file existence before copying.

Suggested change

	await copyFile('README.md', 'dist/README.md');
	try {
	await copyFile('README.md', 'dist/README.md');
	} catch (err) {
	console.error('Failed to copy README.md to dist/README.md:', err.message || err);
	process.exit(1);
	}