Skip to content

Commit

Permalink
docs: ✏️ Update links to dist
Browse files Browse the repository at this point in the history
  • Loading branch information
phun-ky committed Feb 13, 2024
1 parent ceab2dc commit 6e4987b
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 8 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

> A zero dependency package to highlight elements
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](http://makeapullrequest.com) [![SemVer 2.0](https://img.shields.io/badge/SemVer-2.0-green.svg)](http://semver.org/spec/v2.0.0.html) ![npm version](https://img.shields.io/npm/v/@phun-ky/speccer) ![issues](https://img.shields.io/github/issues/phun-ky/speccer) ![license](https://img.shields.io/npm/l/@phun-ky/speccer) ![size](https://img.shields.io/bundlephobia/min/@phun-ky/speccer) ![npm](https://img.shields.io/npm/dm/%40phun-ky/speccer) ![GitHub Repo stars](https://img.shields.io/github/stars/phun-ky/speccer)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](http://makeapullrequest.com) [![SemVer 2.0](https://img.shields.io/badge/SemVer-2.0-green.svg)](http://semver.org/spec/v2.0.0.html) ![npm version](https://img.shields.io/npm/v/@phun-ky/speccer) ![issues](https://img.shields.io/github/issues/phun-ky/speccer) ![license](https://img.shields.io/npm/l/@phun-ky/speccer) ![size](https://img.shields.io/bundlephobia/min/@phun-ky/speccer) ![npm](https://img.shields.io/npm/dm/%40phun-ky/speccer) ![GitHub Repo stars](https://img.shields.io/github/stars/phun-ky/speccer) [![codecov](https://codecov.io/gh/phun-ky/speccer/graph/badge.svg?token=VA91DL7ZLZ)](https://codecov.io/gh/phun-ky/speccer)

![Image of speccer](./public/speccer.png)

Expand Down Expand Up @@ -48,14 +48,14 @@ Go [here](https://github.com/phun-ky/speccer/blob/main/api/README.md) to read th

### Typescript

Types can be found in `@phun-ky/speccer/speccer.d.ts`.
Types can be found in `@phun-ky/speccer/dist/speccer.d.ts`.

### ESM

Either import and run the required functions:

```javascript
import '@phun-ky/speccer/speccer.min.css';
import '@phun-ky/speccer/dist/speccer.min.css';
import speccer from '@phun-ky/speccer';

// do stuff
Expand All @@ -71,6 +71,16 @@ Or place these `script` and `link` tags in your web page:
<script src="../path/to/speccer.js"></script>
```

Or with a CDN:

```html
<link
rel="stylesheet"
href="https://unpkg.com/@phun-ky/speccer/dist/speccer.min.css"
/>
<script src="https://unpkg.com/@phun-ky/speccer/dist/speccer.js"></script>
```

And then follow the steps below to display the specifications you want :)

### React
Expand All @@ -82,7 +92,7 @@ import React, { useEffect } from 'react';
import PropTypes from 'prop-types';

import debounce from './lib/debounce';
import '@phun-ky/speccer/speccer.min.css';
import '@phun-ky/speccer/dist/speccer.min.css';

const Component = () => {
let speccerEventFunc;
Expand Down Expand Up @@ -116,6 +126,12 @@ If you want to control speccer a bit more, you have some options. Apply one of t
<script src="../speccer.js" data-<manual|instant|dom|lazy></script>
```

Or with a CDN:

```html
<script src="https://unpkg.com/@phun-ky/speccer/dist/speccer.js" data-<manual|instant|dom|lazy></script>
```

| Tag | Description |
| -------------- | ------------------------------------------------------------------- |
| `data-manual` | Makes `window.speccer()` available to be used when you feel like it |
Expand Down
7 changes: 3 additions & 4 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ These are the versions that is updated with security patches.

| Version | Supported |
| ------- | ------------------ |
| >= 8.0 | :white_check_mark: |
| < 8.0 | :x: |

| >= 9.0 | :white_check_mark: |
| < 9.0 | :x: |

## Reporting a Vulnerability

Report vulnerabilities to security@phun-ky.net
Report vulnerabilities to <security@phun-ky.net>

0 comments on commit 6e4987b

Please sign in to comment.