Skip to content

Commit

Permalink
📝 docs & readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Harley Alexander committed Aug 21, 2019
1 parent 89535f6 commit beac1ff
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Easy as hooks that integrate with the [pusher-js](https://github.com/pusher/pusher-js) library.
[![NPM](https://img.shields.io/npm/v/use-pusher.svg)](https://www.npmjs.com/package/react-pusher-hooks) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![NPM](https://img.shields.io/npm/v/use-pusher.svg)](https://www.npmjs.com/package/react-pusher-hooks) ![Typed](https://badgen.net/badge//types/Typescript?icon=typescript)

##### [API Reference/Docs](https://mayteio.github.io/use-pusher/)

Expand Down Expand Up @@ -103,7 +103,7 @@ const Example = () => {
A helper function to create a **server triggered** event. BYO server (See [Trigger Server](#trigger-server) below). Pass in `triggerEndpoint` prop to `<PusherProvider />`. Any auth headers from config.auth.headers automatically get passed to the `fetch` call.

```tsx
import {useTrigger} from 'use-pusher`;
import {useTrigger} from 'use-pusher';

const Example = () => {.
const trigger = useTrigger();
Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@
"author": "@mayteio",
"keywords": [
"react",
"react-hooks",
"react hooks",
"pusher",
"channels",
"pusher-js",
"websockets",
"realtime messaging"
"realtime messaging",
"typescript"
],
"license": "MIT",
"repository": "@mayteio/use-pusher",
Expand Down
2 changes: 2 additions & 0 deletions src/mocks.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
// Based off https://github.com/nikolalsvk/pusher-js-mock

import { Member, Config } from "pusher-js";

class PusherChannelMock {
Expand Down

0 comments on commit beac1ff

Please sign in to comment.