Use Client_find_by_session() instead of a few open-coded loops.
[umurmur.git] / README.md
index e3f7efba24a8de482693a62f5c37accf5cb46f56..503a21b7bee2fd219086901654941260528217ad 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,38 +1,33 @@
-uMurmur - minimalistic Mumble server
-====================================
-Hosted on [GitHub](https://github.com/fatbob313/umurmur)
+#About uMurmur
 
-uMurmur is a minimalistic Mumble server primarily targeted to run on routers with an open OS like OpenWRT. The server part of Mumble is called Murmur, hence the name uMurmur. It is available as a precompiled package for some distributions. Check your package repository if you are running OpenWRT or Freetz.
-
-There are makefiles in the [openwrt](https://github.com/fatbob313/umurmur/tree/master/openwrt) subdirectory suitable for building with the OpenWRT SDK. Move the Makefile of choice to the base directory, e.g.:
-
-       mv openwrt/Makefile.polarssl Makefile
-
-and then put the whole umurmur-X.X.X directory in the SDK's 'packages' directory.
+Build for OpenSSL and mbed TLS 2.3/2.4: [![Build Status](https://travis-ci.org/umurmur/umurmur.svg?branch=master)](https://travis-ci.org/umurmur/umurmur)
 
+uMurmur is a minimalistic Mumble server primarily targeted to run on embedded computers, like routers, with an open OS like e.g. OpenWRT. The server part of Mumble is called Murmur, hence the name uMurmur. It is available as a precompiled package for quite a lot distributions. Check your distribution's package repository.
 
 Instructions for building from source
 -------------------------------------
-1. Requirements
-       * [OpenSSL](http://www.openssl.org/) or [PolarSSL](http://polarssl.org/) library
-       * [libconfig](http://www.hyperrealm.com/libconfig/)
-       * [libprotoc-c](http://code.google.com/p/protobuf-c/) version 0.14 (use --disable-protoc option in its ./configure)
-
-2. Build
-       * `./configure`
-       * `make`
-
-3. Install
-       * `make install`
-       * Edit umurmur.conf.example to your liking and put it in a suitable place. /etc/umurmur.conf is default.
-
-4. Run `umurmurd -c <conf file> -p <PID file> -r`. For other switches and their meaning run `umurmurd -h`
-
-A startup script can easily be created if you want to. Just copy an existing script and edit it to your liking.
-
+[Build instructions](https://github.com/umurmur/umurmur/wiki/Building) can be found in the [wiki](https://github.com/umurmur/umurmur/wiki).
+
+Contributors
+------------
+* [Antoine Bertin](https://github.com/Diaoul)
+* Tilman Sauerbeck
+* J Sisson - sisson.j ( AT ) gmail DOT com
+* [pierre.h](http://code.google.com/u/@VBRUQ1ZTAhNEXwJ9/)
+* [phr0z3nt04st](https://github.com/phr0z3nt04st)
+* [Troy C](https://github.com/troxor)
+* [Trivve](https://github.com/Trivve)
+* [hasufell](https://github.com/hasufell)
+* [fmorgner](https://github.com/fmorgner)
+* [Rawi666](https://github.com/Rawi666)
+* [snowblind](https://github.com/snowblind)
+* [c4k3](https://github.com/C4K3)
+* [l2dy](https://github.com/l2dy)
+
+Hope I didn't forget anyone... Please just send me a mail if you feel this is the case.
 
 Support/Contact/Documentation
 -----------------------------
-See the project page, link above.
+Please consult the [wiki](https://github.com/umurmur/umurmur/wiki) and use the [issue tracker](https://github.com/umurmur/umurmur/issues) to report problems with uMurmur or to submit feature requests.
 
 Have fun!