Skip to content

Commit 32c2b05

Browse files
authored
Update README.md
1 parent dfa8005 commit 32c2b05

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
# github-embedder
1+
# markdown-embedder
22

33
> Anyway, sorry for my English. Pull request for me if you insist on improvement this document :)
44
55
This package is for getting a context from external link that should contain a raw markdown only, then we will convert into HTML element and render to `.g-embed` class.
66

77
## Usage
88

9-
Import a script `git-embbeder.js` from `dist` folder into bottom of your page.
9+
Import a script `markdown-embbeder.js` from `dist` folder into bottom of your page.
1010

1111
> Note: this script not work inside `<head>` tag and only working after all page rendered. that meaning you should add this script into bottom of you site before your `</body>` close tag
1212
1313
```html
14-
<script src="/path/to/git-embedder.js"></script>
14+
<script src="/path/to/markdown-embedder.js"></script>
1515
```
1616

1717
Then add any HTML element that contain a `class="g-embed"` attribute with your external link of raw markdown in `data-url="http://example.com/markdown.md"`

0 commit comments

Comments
 (0)