Skip to content

Commit

Permalink
docs: readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
jankapunkt committed Aug 31, 2023
1 parent bc50751 commit 52e9674
Showing 1 changed file with 34 additions and 10 deletions.
44 changes: 34 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
# Easy Speech
<h1 align="center">Easy Speech</h1>

<div align="center">
Cross browser Speech Synthesis; no dependencies.
</div>

<p align="center">
<br />
<a href="https://github.com/jankapunkt/easy-speech/blob/master/API.md"><strong>API docs »</strong></a>
<br />
</p>


[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
Expand All @@ -9,22 +20,35 @@
![npm bundle size](https://img.shields.io/bundlephobia/minzip/easy-speech)


Cross browser Speech Synthesis; no dependencies.

## ⭐️ Why EasySpeech?

This project was created, because it's always a struggle to get the synthesis
part of `Web Speech API` running on most major browsers.

**Note:** this is not a polyfill package, if your target browser does not
support speech synthesis or the Web Speech API, this package is not usable.
## ✨ Features

- 🪄 Single API for using `speechSynthesis` across multiple browsers
- 🌈 Async API (Promises, async/await)
- 🚀 Hooks for all events; global and/or voice-instance-specific
- 🌱 Easy to set up and integrate: auto-detects and loads available voices
- 🔧 Includes fixes or workarounds for many browser-specific quirks
- 📝 Internal logging via `EasySpeech.debug` hook
- 📦 Multiple build targets
- 🎮 Live demo to test your browser


**Note:** this is not a polyfill package, if your target browser does not support speech synthesis or the Web Speech
API, this package is not usable.

## Live Demo
## 🚀 Live Demo

The live demo is available at https://jankapunkt.github.io/easy-speech/
You can use it to test your browser for `speechSynthesis` support and functionality.

[![live demo screenshot](./docs/demo_screenshot.png)](https://jankapunkt.github.io/easy-speech/)

## Installation
## 📦 Installation

Install from npm via

Expand Down Expand Up @@ -56,7 +80,7 @@ You can use them via CDN:
<script src="https://cdn.jsdelivr.net/npm/easy-speech/dist/EasySpeech.iife.js"></script>
```

## Usage
## 👨‍💻 Usage

Import `EasySpeech` and first, detect, if your browser is capable of tts (text
to speech):
Expand Down Expand Up @@ -153,19 +177,19 @@ an error occurred. You can additionally attach these event listeners if you like
or use `EasySpeech.on` to attach default listeners to every time you call
`EasySpeech.speak`.

## API
## 🔬 API

There is a full API documentation available: [api docs](./API.md)

## Contribution and development
## ⌨️ Contribution and development

Every contribution is welcomed, please open issues if anything is not working
as expected.

If you intend to contribute code, please read the
[guidelines on contributing](./CONTRIBUTING.md).

## Resources
## 📖 Resources

This project used several resources to gain insights about how to get the best cross-browser SpeechSynthesis running:

Expand Down

0 comments on commit 52e9674

Please sign in to comment.