Skip to content

Commit ce1e87a

Browse files
authored
Update README.md
1 parent 5ce9f93 commit ce1e87a

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22

33
A quick easy way to access [MeloTTS](https://github.com/myshell-ai/MeloTTS) through REST API calls.
44

5-
## Usage
5+
## Build Image
6+
Assuming you have docker installed and setup.
67

7-
Assuming you have docker installed and setup
8-
9-
### Build
108
(This might take a bit because MeloTTS is a big dependency)
119
#### Local
1210

@@ -18,7 +16,7 @@ Assuming you have docker installed and setup
1816

1917
docker pull timhagel/melotts-api-server
2018

21-
### Languages and Speakers
19+
## Languages and Speakers
2220

2321
#### Language
2422

@@ -38,6 +36,8 @@ Assuming you have docker installed and setup
3836
- EN-Default - Default English accent
3937
- **Notice!** Currently only English accents are working, and other accents are returning an error. This does not mean that other languages do not work!
4038

39+
## Running
40+
4141
### Run (CPU) (English)
4242

4343
docker run --name melotts-server -p 8888:8080 -e DEFAULT_SPEED=1 -e DEFAULT_LANGUAGE=EN -e DEFAULT_SPEAKER_ID=EN-Default timhagel/melotts-api-server
@@ -46,11 +46,12 @@ Assuming you have docker installed and setup
4646

4747
docker run --name melotts-server -p 8888:8080 --gpus=all -e DEFAULT_SPEED=1 -e DEFAULT_LANGUAGE=EN -e DEFAULT_SPEAKER_ID=EN-Default timhagel/melotts-api-server
4848

49-
### Call API
49+
## Call API
5050

5151
**localhost:8888/convert/tts**
5252

53-
##### Use Environment Defaults
53+
### Use Environment Defaults
54+
Response: .wav
5455

5556
###### Post body:
5657
```
@@ -67,10 +68,9 @@ curl http://localhost:8888/convert/tts \
6768
--output "example.wav"
6869
```
6970

71+
### Customize (Everything except for "text" is optional)
7072
Response: .wav
7173

72-
##### Customize (Everything except for "text" is optional)
73-
7474
###### Post body:
7575
```
7676
{
@@ -94,8 +94,6 @@ curl http://localhost:8888/convert/tts \
9494
--output "example.wav"
9595
```
9696

97-
Response: .wav
98-
9997
## Acknowledgement
10098

10199
This is just an API server for the awesome work of [MeloTTS](https://github.com/myshell-ai/MeloTTS) from [MyShell](https://github.com/myshell-ai)

0 commit comments

Comments
 (0)