diff --git a/README.md b/README.md index 945fdf4..204eecc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# UDPXD - A general purpose UDP relay/port forwarder/proxy +[![Build Status](https://travis-ci.org/TLINDEN/udpxd.svg?branch=master)](https://travis-ci.org/TLINDEN/udpxd) + +## UDPXD - A general purpose UDP relay/port forwarder/proxy This is the README file for the network program udpxd. @@ -7,7 +9,7 @@ to another port on another system. It also supports binding to a specific ip address which will be used as the source for outgoing packets. -# Documentation +## Documentation You can read the documentation without installing the software: @@ -18,7 +20,7 @@ If it is already installed, you can read the manual page: man udpxd -# Installation +## Installation This software doesn't have eny external dependencies, but you need either BSD make or GNU make installed to build it. @@ -44,7 +46,7 @@ modify `$PREFIX` during installation time like this: make install PREFIX=/opt -# Getting help +## Getting help Although I'm happy to hear from module users in private email, that's the best way for me to forget to do something. @@ -53,14 +55,14 @@ In order to report a bug, unexpected behavior, feature requests or to submit a patch, please open an issue on github: https://github.com/TLINDEN/udpxd/issues. -# Copyright and license +## Copyright and license This software is licensed under the GNU GENERAL PUBLIC LICENSE version 3. -# Authors +## Authors T.v.Dein -# Project homepage +## Project homepage https://github.com/TLINDEN/udpxd \ No newline at end of file