From 3024236566d525800f5acfea6df4c0b73317b84d Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Wed, 8 Jul 2026 14:28:43 +0000 Subject: [PATCH] docs: remove npm install claim, prep npm metadata Co-authored-by: Daniel Vega Pino --- README.md | 13 ++++++++++++- package.json | 7 +++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ba519e7..cc36551 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,19 @@ Use it when you ship a self-contained React bundle and need a stable, framework- ## Install +> Note: `react-app-element` is **not published to the npm registry yet**. +> The instructions below install/use it from this repository (after building `dist/`). + ```bash -npm install react-app-element +# 1) Build this repo (generates dist/) +npm install +npm run build + +# 2) In your consuming project, install this repo as a local dependency +# (the local install will pick up the generated dist/ folder) +npm install file:../path/to/react-app-element + +# Your host app must also provide peer dependencies: npm install react react-dom # peer dependencies — same major as your app ``` diff --git a/package.json b/package.json index 7ac4e57..e01ab69 100644 --- a/package.json +++ b/package.json @@ -11,10 +11,17 @@ "keywords": [ "react", "web-components", + "web-component", "custom-elements", + "custom-element", "micro-frontend", + "microfrontends", "embed" ], + "homepage": "https://github.com/dvegap95/react-app-element#readme", + "bugs": { + "url": "https://github.com/dvegap95/react-app-element/issues" + }, "main": "./dist/main.js", "module": "./dist/main.js", "types": "./dist/main.d.ts",