Skip to content

Commit f019cf6

Browse files
committed
docs: add cdn usage and badge in readme
1 parent 9e7cb7d commit f019cf6

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Splunk Search Processing Language for [highlight.js](https://highlightjs.org/)
22

3+
[![npm version](https://img.shields.io/npm/v/highlightjs-spl?color=success)](https://www.npmjs.com/package/highlightjs-spl) ![license](https://img.shields.io/github/license/swsoyee/highlightjs-spl) ![jsDelivr](https://img.shields.io/jsdelivr/gh/hy/swsoyee/highlightjs-spl?color=blue&label=jsDelivr)
4+
35
## Usage
46

57
Simply include the `highlight.js` library in your webpage or Node app, then load this module.
@@ -16,11 +18,24 @@ Simply load the module after loading `highlight.js`. You'll use the minified ve
1618
</script>
1719
```
1820

19-
### [WIP] Using directly from the UNPKG CDN
21+
### Using directly from the CDN
22+
23+
**jsDelivr**
24+
25+
```html
26+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@10.7.1/build/styles/default.min.css">
27+
<script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@10.7.1/build/highlight.min.js"></script>
28+
<!-- load syntax definition for Splunk search processing language -->
29+
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/swsoyee/highlightjs-spl/dist/spl.min.js"></script>
30+
```
31+
32+
**unpkg**
2033

2134
```html
22-
<!-- <script type="text/javascript"
23-
src="https://unpkg.com/highlightjs-spl@0.1.0/dist/spl.min.js"></script> -->
35+
<link rel="stylesheet" href="https://unpkg.com/@highlightjs/cdn-assets@10.7.1/styles/default.min.css">
36+
<script src="https://unpkg.com/@highlightjs/cdn-assets@10.7.1/highlight.min.js"></script>
37+
<!-- load syntax definition for Splunk search processing language -->
38+
<script type="text/javascript" src="https://unpkg.com/highlightjs-spl/dist/spl.min.js"></script>
2439
```
2540

2641
- More info: <https://unpkg.com>

0 commit comments

Comments
 (0)