# readandspeech

> Read a text

Latest version **0.0.7** (published 2021-06-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install readandspeech
pnpm add readandspeech
yarn add readandspeech
bun add readandspeech
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.7 |
| Published | 2021-06-15 |
| First published | 2021-06-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 473.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Arnaud POINTET |
| Maintainers | forelse |
| Keywords | read, speech, text-to-speech, SpeechSynthesis |

## Links

- npm: https://www.npmjs.com/package/readandspeech
- Repository: https://github.com/Oipnet/readAndSpeech
- Issues: https://github.com/Oipnet/readAndSpeech/issues
- npm.io page: https://npm.io/package/readandspeech

## Dependencies (1)

- [emojilib](https://npm.io/package/emojilib.md) ^3.0.2

## Alternatives

- [csv-to-markdown-table](https://npm.io/package/csv-to-markdown-table.md) — 47.0K weekly downloads
- [@sapphire/ratelimits](https://npm.io/package/@sapphire/ratelimits.md) — 4.4K weekly downloads
- [js-csvparser](https://npm.io/package/js-csvparser.md) — 2.0K weekly downloads
- [@adadapted/js-sdk](https://npm.io/package/@adadapted/js-sdk.md) — 251 weekly downloads
- [@grapecity/spread-sheets-sparklines](https://npm.io/package/@grapecity/spread-sheets-sparklines.md) — 103 weekly downloads

## Recent versions

- 0.0.7 (latest) — 2021-06-15
- 0.0.6 — 2021-06-04
- 0.0.5 — 2021-06-04
- 0.0.4 — 2021-06-03
- 0.0.3 — 2021-06-03
- 0.0.2 — 2021-06-03
- 0.0.1 — 2021-06-03

## README

# readAndSpeech

## Présentation
ReadAndSpeech is an opensource library.
You can read a text using the native API [SpeechSynthesis](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesis).

## Installation
Use npm to install the library.
```
npm install readandspeech
```

## Usage
```javascript
import ReadAndSpeech from 'readandspeech'

const readAndSpeech = new ReadAndSpeech // Initialise reader

document.querySelector('button').addEventListener('click', (e) => {
  e.preventDefault()
  readAndSpeech.speak('Hello world')
})
```

You can enable a emoji parser with the parameter translateEmoji. Default value is false.
Translator is based on [emojilib](https://github.com/muan/emojilib)
```javascript
import ReadAndSpeech from 'readandspeech'

const readAndSpeech = new ReadAndSpeech({
  translateEmoji: true
}) // Initialise reader
````

## Contribute
You can contribute to improve the project.
Fork the repo, create a branch, push your modification and submit a pull request

---
_Source: https://npm.io/package/readandspeech · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._