Skip to content

Commit

Permalink
chore: update package metadata & doc
Browse files Browse the repository at this point in the history
  • Loading branch information
swiiny committed Oct 17, 2023
1 parent f927c7c commit 585c544
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 13 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
# `highlightjs-huff`
# `prismjs-huff`

Huff syntax highlighting for [highlight.js](https://highlightjs.org/).
[Huff](https://huff.sh/) syntax highlighting for [react-syntax-highlighter](https://github.com/react-syntax-highlighter/react-syntax-highlighter#readme).

Huff is a low level assembly language for the EVM. See [documatation](https://docs.huff.sh/)

## Installation

```bash
npm install highlightjs-huff
npm install prismjs-huff
```

> Please note that this package requires `highlight.js` as a peer dependency.
## Usage

```javascript
import hljs from 'highlight.js';
import huff from 'highlightjs-huff';
import { PrismLight } from 'react-syntax-highlighter';
import huff from 'prismjs-huff';

hljs.registerLanguage('huff', huff);
hljs.highlightAll();
PrismLight.registerLanguage('huff', huff);
```

## License
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "prismjs-huff",
"private": false,
"version": "1.1.0",
"version": "1.1.1",
"description": "Huff syntax highlighting for prism.js",
"main": "src/index.js",
"types": "src/index.d.ts",
Expand All @@ -10,7 +10,7 @@
],
"repository": {
"type": "git",
"url": "git+ssh://git@github.com/JeremyTheintz/prismjs-huff.git"
"url": "git+ssh://git@github.com/swiiny/prismjs-huff.git"
},
"keywords": [
"Huff",
Expand All @@ -22,7 +22,7 @@
"author": "Jeremy Theintz",
"license": "MIT",
"bugs": {
"url": "https://github.com/JeremyTheintz/prismjs-huff/issues"
"url": "https://github.com/swiiny/prismjs-huff/issues"
},
"homepage": "https://github.com/JeremyTheintz/prismjs-huff"
"homepage": "https://github.com/swiiny/prismjs-huff"
}

0 comments on commit 585c544

Please sign in to comment.