Skip to content

Commit 5911d60

Browse files
committed
Update README
1 parent b83bed5 commit 5911d60

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
1-
# <custom-element> element
1+
# <typing-effect> element
22

3-
Boilerplate for creating a custom element.
3+
A custom element that shows text as if it were being typed
44

55
## Installation
66

77
```
8-
$ npm install @github/custom-element-element
8+
$ npm install @github/typing-effect-element
99
```
1010

1111
## Usage
1212

1313
```js
14-
import '@github/custom-element-element'
14+
import '@github/typing-effect-element'
1515
```
1616

1717
```html
18-
<custom-element></custom-element>
18+
<typing-effect data-lines='["Welcome to GitHub!", "Let’s begin the adventure"]'>
19+
<span data-target="typing-effect.content"></span>
20+
<span data-target="typing-effect.cursor">|</span>
21+
</typing-effect>
1922
```
2023

2124
## Browser support

0 commit comments

Comments
 (0)