Update README
This commit is contained in:
Родитель
b83bed53d9
Коммит
5911d602e2
13
README.md
13
README.md
|
@ -1,21 +1,24 @@
|
||||||
# <custom-element> element
|
# <typing-effect> element
|
||||||
|
|
||||||
Boilerplate for creating a custom element.
|
A custom element that shows text as if it were being typed
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```
|
```
|
||||||
$ npm install @github/custom-element-element
|
$ npm install @github/typing-effect-element
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import '@github/custom-element-element'
|
import '@github/typing-effect-element'
|
||||||
```
|
```
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<custom-element></custom-element>
|
<typing-effect data-lines='["Welcome to GitHub!", "Let’s begin the adventure"]'>
|
||||||
|
<span data-target="typing-effect.content"></span>
|
||||||
|
<span data-target="typing-effect.cursor">|</span>
|
||||||
|
</typing-effect>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Browser support
|
## Browser support
|
||||||
|
|
Загрузка…
Ссылка в новой задаче