Skip to content

Commit

Permalink
doc: edit readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pxgo committed May 2, 2024
1 parent c7214d3 commit 7b3a8fd
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@ GoFM
GoFM is a cross-platform real-time audio streaming server written in Go. It allows you to stream MP3 audio files from a specified directory over HTTP and synchronize playback across multiple clients.

[![Go Version](https://img.shields.io/badge/Go-v1.16-blue)](https://golang.org/dl/)
[![Go Report Card](https://goreportcard.com/badge/github.com/pxgo/GoFM)](https://goreportcard.com/report/github.com/pxgo/GoFM)
[![Downloads](https://img.shields.io/github/downloads/pxgo/GoFM/total)](https://github.com/pxgo/GoFM/releases)
[![References](https://img.shields.io/github/forks/pxgo/GoFM?label=references)](https://github.com/pxgo/GoFM/network/members)
[![License](https://img.shields.io/github/license/pxgo/GoFM)](https://github.com/pxgo/GoFM/blob/main/LICENSE)
[![Go Report Card](https://goreportcard.com/badge/github.com/ssnat/GoFM)](https://goreportcard.com/report/github.com/ssnat/GoFM)
[![Downloads](https://img.shields.io/github/downloads/pxgo/GoFM/total)](https://github.com/ssnat/GoFM/releases)
[![References](https://img.shields.io/github/forks/pxgo/GoFM?label=references)](https://github.com/ssnat/GoFM/network/members)
[![License](https://img.shields.io/github/license/pxgo/GoFM)](https://github.com/ssnat/GoFM/blob/main/LICENSE)

![GoFM](./statics/GoFM_home.png)

Usage
-----
To use GoFM, download the latest release from the [Releases page](https://github.com/pxgo/GoFM/releases) and run the server with the following command:
## Usage

To use GoFM, download the latest release from the [Releases page](https://github.com/ssnat/GoFM/releases) and run the server with the following command:

```
./GoFM -d /path/to/your/music/directory
Expand Down Expand Up @@ -40,10 +41,9 @@ For example, to change the server's port number to 8080, use the -p option follo
```
./GoFM -d /path/to/your/music/directory -p 8080
```
Available Online Services
-----
Taylor's music: [https://fm.stackstore.net](https://fm.stackstore.net)

License
-----
GoFM is released under the [MIT License](https://github.com/pxgo/GoFM/blob/main/LICENSE). Feel free to use, modify, and distribute the software. Contributions are welcome!
You can find more information about GoFM on [STACKSTORE](https://stackstore.net/GoFM).

## License

GoFM is released under the [MIT License](https://github.com/ssnat/GoFM/blob/main/LICENSE). Feel free to use, modify, and distribute the software. Contributions are welcome!
Binary file added statics/GoFM_home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7b3a8fd

Please sign in to comment.