Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down
7 changes: 7 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Loading