Skip to content

Commit 52e9674

Browse files
committed
docs: readme updated
1 parent bc50751 commit 52e9674

File tree

1 file changed

+34
-10
lines changed

1 file changed

+34
-10
lines changed

README.md

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
1-
# Easy Speech
1+
<h1 align="center">Easy Speech</h1>
2+
3+
<div align="center">
4+
Cross browser Speech Synthesis; no dependencies.
5+
</div>
6+
7+
<p align="center">
8+
<br />
9+
<a href="https://github.com/jankapunkt/easy-speech/blob/master/API.md"><strong>API docs »</strong></a>
10+
<br />
11+
</p>
12+
213

314
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
415
[![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)
@@ -9,22 +20,35 @@
920
![npm bundle size](https://img.shields.io/bundlephobia/minzip/easy-speech)
1021

1122

12-
Cross browser Speech Synthesis; no dependencies.
23+
24+
## ⭐️ Why EasySpeech?
1325

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

17-
**Note:** this is not a polyfill package, if your target browser does not
18-
support speech synthesis or the Web Speech API, this package is not usable.
29+
## ✨ Features
30+
31+
- 🪄 Single API for using `speechSynthesis` across multiple browsers
32+
- 🌈 Async API (Promises, async/await)
33+
- 🚀 Hooks for all events; global and/or voice-instance-specific
34+
- 🌱 Easy to set up and integrate: auto-detects and loads available voices
35+
- 🔧 Includes fixes or workarounds for many browser-specific quirks
36+
- 📝 Internal logging via `EasySpeech.debug` hook
37+
- 📦 Multiple build targets
38+
- 🎮 Live demo to test your browser
39+
40+
41+
**Note:** this is not a polyfill package, if your target browser does not support speech synthesis or the Web Speech
42+
API, this package is not usable.
1943

20-
## Live Demo
44+
## 🚀 Live Demo
2145

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

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

27-
## Installation
51+
## 📦 Installation
2852

2953
Install from npm via
3054

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

59-
## Usage
83+
## 👨‍💻 Usage
6084

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

156-
## API
180+
## 🔬 API
157181

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

160-
## Contribution and development
184+
## ⌨️ Contribution and development
161185

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

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

168-
## Resources
192+
## 📖 Resources
169193

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

0 commit comments

Comments
 (0)