also accept files according to their extension

[botaradio.git] / README.md

diff --git a/README.md b/README.md
index 3f896fb0c29f8857d5c48c575d57590d18960e2c..80f229edde5a220e1723ff99d877ff234d172d27 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,12 @@
-# botamusique
+# botaradio
 
-Botamusique is a [Mumble](https://www.mumble.info/) music bot.
-Predicted functionalities will be those people would expect from any classic music player.
+Botaradio is a fork of botamusique, a [Mumble](https://www.mumble.info/) music bot.
+Its functionalities are those people would expect from any classic music player,
+Botaradio is itself focused on functionalities expected in a broadcast radio
+context.
+
+References to Botamusique are still present all around the source code, and
+this document, they pretty much apply.
 
 
 ## Features
@@ -9,8 +14,8 @@ Predicted functionalities will be those people would expect from any classic mus
 1. **Support multiple music sources:**
     - Music in local folders (which can be uploaded through the web interface).
     - Youtube/Soundcloud URLs and playlists (everything supported by youtube-dl).
-    - Radio stations from url and http://www.radio-browser.info API (query from > 24k stations).
-2. **User-friendly web remote control interface.** Powered by flask. Which supports
+    - Radio stations from URL and http://www.radio-browser.info API (query from > 24k stations).
+2. **User-friendly web remote control interface.** Powered by Flask. Which supports
     - Playlist management,
     - File management,
     - Upload files, etc.
@@ -43,9 +48,9 @@ Predicted functionalities will be those people would expect from any classic mus
 1. Install ffmpeg. If ffmpeg isn't in your package manager, you may need to find another source. I personally use [this repository](http://repozytorium.mati75.eu/) on my raspberry.
 
 #### Install botamusique
-Stable release (**recommended**, with build-in auto-update support):
+Stable release (**recommended**):
 ```
-curl -Lo botamusique.tar.gz https://azlux.fr/botamusique/sources.tar.gz
+curl -Lo botamusique.tar.gz http://packages.azlux.fr/botamusique/sources.tar.gz
 tar -xzf botamusique.tar.gz
 cd botamusique
 python3 -m venv venv
@@ -54,7 +59,7 @@ venv/bin/pip install -r pymumble/requirements.txt
 venv/bin/pip install -r requirements.txt
 ```
 
-For the version of the master branch (no build-in auto-update support):
+Testing version (from master):
 ```
 git clone --recurse-submodules https://github.com/azlux/botamusique.git
 cd botamusique
@@ -113,7 +118,7 @@ listening_port = 8181
 
 You can access the web interface through http://127.0.0.1:8181 if you keep it unchanged.
 
-Note: Listening to address `127.0.0.1` will only accept requests from localhost. If you would to accept requests from the public internet, you need to set it to `0.0.0.0`, and set up username and password to impose access control. In addition, if the bot is behind a router, you should also properly set forwarding rules in you NAT configuration to forward requests to your router to the bot.
+Note: Listening to address `127.0.0.1` will only accept requests from localhost. If you would like to accept requests from the public internet, you need to set it to `0.0.0.0`, and set up username and password to impose access control. In addition, if the bot is behind a router, you should also properly set forwarding rules in you NAT configuration to forward requests to your router to the bot.
 
 
 ### Starting the bot
@@ -123,7 +128,7 @@ If you have set up everything in your `configuration.ini`, you can
 Or you can
 `venv/bin/python mumbleBot.py -s HOST -u BOTNAME -P PASSWORD -p PORT -c CHANNEL -C /path/to/botamusique.pem`
 
-If you want information about auto-starting and auto-restarting of the bot, [you can check out the wiki].(https://github.com/azlux/botamusique/wiki/Run-botamusique-as-a-daemon-In-the-background)
+If you want information about auto-starting and auto-restarting of the bot, you can check out the wiki page [Run botamusique as a daemon In the background](https://github.com/azlux/botamusique/wiki/Run-botamusique-as-a-daemon-In-the-background).
 
 **For the detailed manual of using botamusique, please see the [wiki](https://github.com/azlux/botamusique/wiki).**
 
@@ -155,7 +160,7 @@ Exception: Could not find opus library. Make sure it is installed.
 You need to install the opus codec (not embedded in all system): `apt install libopus0`
 
 
-### Contributors
+### Contributors (botamusique)
 If you want to participate, You're welcome to fork and submit pull requests (fixes and new features).
 
 The following people joined the collaborators for a faster development, big thanks to them: