Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
newying61 authored Aug 19, 2019
1 parent 9e18958 commit 51fbd90
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
# web-components-with-react
Render React App inside web components, supporting React Hooks.
Render React App or any component inside web components, supporting React Hooks.

By default the react App will be rendered inside shadow DOM.

## Compared to other libs
- Supporing React version with Hooks (16.9.0)
- No extra lifecycle methods, just use React componentDidMount etc.
- Re-render React component on attributes changes
- Exporting the React web components for inheriting, define customElement whenever you like
- Simple

## Installation
Package web-components-with-react is available on npm.

```
yarn add web-components-with-react
```
`yarn add web-components-with-react`

or

```
npm install web-components-with-react
```
`npm install web-components-with-react`

## Basic Usage
Wrap the React App with ReactCustomElement and then use customElements.define() to create the web component.
Expand Down

0 comments on commit 51fbd90

Please sign in to comment.