Skip to content

Commit

Permalink
Merge pull request #24 from frontapp/readme_package
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
cjmckee authored Dec 9, 2024
2 parents 976b534 + a79812d commit f334e1f
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@
[![Issues][issues-shield]][issues-url]
[![Apache 2.0 License][license-shield]][license-url]

<!-- NPM PACKAGE LOGO -->

<a href="https://badge.fury.io/js/front-chat-sdk"><img src="https://badge.fury.io/js/front-chat-sdk.svg" alt="npm version" height="18" />

<!-- PROJECT LOGO -->
<br />
<p align="center">
Expand Down Expand Up @@ -75,6 +79,22 @@ To learn more about Front Chat, check out [this article](https://help.front.com/

## Getting Started

We now have an <a href="https://www.npmjs.com/package/front-chat-sdk">npm package</a> available!

```sh
npm i front-chat-sdk
```

```ts
import {initialize} from 'front-chat-sdk/helpers';
import {useFrontChat} from 'front-chat-sdk/hooks';
import type {FrontChat} from 'front-chat-sdk/types';
```

See [examples](https://github.com/frontapp/front-chat-sdk/tree/main/examples) for more on how to use front-chat-sdk.

## Running front-chat-sdk locally

### Install and Run

1. Clone the repo
Expand Down

0 comments on commit f334e1f

Please sign in to comment.