Skip to content

Commit

Permalink
fix typo + add badges in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Sysix committed Jun 17, 2024
1 parent fe67e1e commit 53ceae3
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# breadcast-single-worker
# broadcast-single-worker

![test](https://github.com/Sysix/broadcast-single-worker/actions/workflows/test.yml/badge.svg)(https://github.com/Sysix/broadcast-single-worker/actions/workflows/test.yml)
![NPM Version](https://img.shields.io/npm/v/%40sysix%2Fbroadcast-single-worker)
![NPM License](https://img.shields.io/npm/l/!%5BNPM%20Version%5D(https%3A%2F%2Fimg.shields.io%2Fnpm%2Fv%2F%2540sysix%252Fbroadcast-single-worker))

## Setup

Expand All @@ -9,9 +13,9 @@ Install with npm:
Use it in your code:

```typescript
import BreadcastSingleWorker from '@sysix/broeadcast-single-worker';
import BroadcastSingleWorker from '@sysix/broadcast-single-worker';

const worker = new BreadcastSingleWorker('channel_name');
const worker = new BroadcastSingleWorker('channel_name');

worker.addListener('start-worker', () => {
// this code will only be executed for a single tab
Expand Down
2 changes: 1 addition & 1 deletion src/BroadcastSingleWorker.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Object.defineProperty(window, 'BroadcastChannel', {
}
})

describe('breadocast single worker', () => {
describe('broadocast single worker', () => {
test('fire start-worker event when connecting', () => {
const worker = new BroadcastSingleWorker('worker');
const startCallback = jest.fn();
Expand Down

0 comments on commit 53ceae3

Please sign in to comment.