From 02315f4c17d98043e68831c32e47d46b6f269e5a Mon Sep 17 00:00:00 2001 From: aditya-K2 Date: Wed, 31 Aug 2022 18:37:25 +0530 Subject: [PATCH] UPDATE: docs --- README.md | 2 +- docs/index.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2836529..f9248b6 100644 --- a/README.md +++ b/README.md @@ -48,5 +48,5 @@ go build # Setting Up -- [Configuring](https://aditya-K2.github.io/gomp/) +- [Documentation](https://aditya-K2.github.io/gomp/) - [Video Showcase](https://github.com/aditya-K2/gomp/tree/master/extras/showcase.md) diff --git a/docs/index.md b/docs/index.md index 399e7f4..d691c3f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,6 +29,7 @@ MPD_PORT : "6600" ## Network Type By Default gomp assumes that you connect to MPD Server through tcp, But if your MPD Server is configured to expose a unix socket rather than a port, then you can specify network type to "unix" +Defaults to `tcp` if not provided. ```yml NETWORK_TYPE : "unix" @@ -39,7 +40,7 @@ Read More about it in the [sample_config](https://github.com/aditya-K2/gomp/blob ## Network Address The Address of the Host for e.g `"localhost"` or `"/path/to/unix/socket/"` if you are using unix sockets -Defaults to `localhost` +Defaults to `localhost` if not provided. ```yml NETWORK_ADDRESS : "/home/$USER/.mpd/socket"