Migrate documentation to markdown

Issue:		#33
pull/13/head
Daniel Roethlisberger 10 years ago
parent 50001e5458
commit 67ed768fec

@ -1,6 +1,7 @@
SSLsplit - transparent and scalable SSL/TLS interception
Copyright (C) 2009-2014, Daniel Roethlisberger <daniel@roe.ch>
# SSLsplit - transparent and scalable SSL/TLS interception
Copyright (C) 2009-2014, [Daniel Roethlisberger](//daniel.roe.ch/).
http://www.roe.ch/SSLsplit
[![Build Status](https://travis-ci.org/droe/sslsplit.svg?branch=master)](https://travis-ci.org/droe/sslsplit)
## Overview
@ -35,10 +36,11 @@ The build depends on GNU make and a POSIX.2 environment in `PATH`.
The optional unit tests depend on the check library.
SSLsplit currently supports the following operating systems and NAT mechanisms:
- FreeBSD: pf rdr and divert-to, ipfw fwd, ipfilter rdr
- OpenBSD: pf rdr-to and divert-to
- Linux: netfilter REDIRECT and TPROXY
- Mac OS X: ipfw fwd and pf rdr (experimental)
- Mac OS X: ipfw fwd and pf rdr
## Installation
@ -53,6 +55,7 @@ respective locations manually by setting `OPENSSL_BASE`, `LIBEVENT_BASE` and/or
`CHECK_BASE` to the respective prefixes.
You can override the default install prefix (`/usr/local`) by setting `PREFIX`.
For more build options see `GNUmakefile`.
## Development
@ -72,16 +75,16 @@ See the respective source file headers for details.
## Credits
SSLsplit was inspired by mitm-ssl by Claes M. Nyberg and sslsniff by Moxie
SSLsplit was inspired by `mitm-ssl` by Claes M. Nyberg and `sslsniff` by Moxie
Marlinspike, but shares no source code with them.
SSLsplit includes khash.h by Attractive Chaos.
SSLsplit includes `khash.h` by Attractive Chaos.
## Contributors
The following individuals have contributed to the SSLsplit codebase, in
chronological order of first contribution, and their Github user names:
chronological order of first contribution:
- Daniel Roethlisberger (@droe), main author
- Steve Wills (@swills)
Loading…
Cancel
Save