Skip to content

Commit

Permalink
docs: update root readme. (#45)
Browse files Browse the repository at this point in the history
* docs: update root readme.

* docs: add examples link.

* docs: reorder content.
  • Loading branch information
morganney authored Jun 1, 2023
1 parent b06d970 commit 75641ca
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# [`tts-react`](https://www.npmjs.com/package/tts-react)

![CI](https://github.com/morganney/tts-react/actions/workflows/ci.yml/badge.svg)
[![codecov](https://codecov.io/gh/morganney/tts-react/branch/main/graph/badge.svg?token=ZDP1VBC8E1)](https://codecov.io/gh/morganney/tts-react)
[![NPM version](https://img.shields.io/npm/v/tts-react.svg)](https://www.npmjs.com/package/tts-react)

<img src="./packages/tts-react/tts-react.png" alt="TextToSpeech React component" width="375" />

Repository for `tts-react`, a React component and hook that uses the [`SpeechSynthesis`](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis) and [`SpeechSynthesisUtterance`](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesisUtterance) API's to convert text to speech. You can fallback to the [`HTMLAudioElement`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/audio) API by providing a `fetchAudioData` prop to the hook or component.

## Install
Expand All @@ -10,6 +16,7 @@ Repository for `tts-react`, a React component and hook that uses the [`SpeechSyn

* [tts-react](./packages/tts-react)
* [storybook](./packages/story)
* [examples](./docs/examples.md)

## Demo (Storybook)

Expand Down

0 comments on commit 75641ca

Please sign in to comment.