update readme slogan

This commit is contained in:
Thomas Kriechbaumer 2018-09-15 11:54:18 +00:00
parent 4be387d654
commit f95784ba9d
4 changed files with 11 additions and 10 deletions

View File

@ -5,8 +5,8 @@ mitmproxy
This repository contains the **mitmproxy** and **pathod** projects. This repository contains the **mitmproxy** and **pathod** projects.
``mitmproxy`` is an interactive, SSL-capable intercepting proxy with a console ``mitmproxy`` is an interactive, SSL/TLS-capable intercepting proxy with a console
interface. interface for HTTP/1, HTTP/2, and WebSockets.
``mitmdump`` is the command-line version of mitmproxy. Think tcpdump for HTTP. ``mitmdump`` is the command-line version of mitmproxy. Think tcpdump for HTTP.
@ -28,7 +28,7 @@ and pathod websites.
The documentation for mitmproxy is available on our website: The documentation for mitmproxy is available on our website:
|mitmproxy_docs_stable| |mitmproxy_docs_master| |mitmproxy_docs_stable| |mitmproxy_docs_master|
Join our discussion forum on Discourse to ask questions, help Join our discussion forum on Discourse to ask questions, help
@ -153,7 +153,7 @@ with the following command:
.. |mitmproxy_docs_stable| image:: https://shields.mitmproxy.org/api/docs-stable-brightgreen.svg .. |mitmproxy_docs_stable| image:: https://shields.mitmproxy.org/api/docs-stable-brightgreen.svg
:target: https://docs.mitmproxy.org/stable/ :target: https://docs.mitmproxy.org/stable/
:alt: mitmproxy documentation stable :alt: mitmproxy documentation stable
.. |mitmproxy_docs_master| image:: https://shields.mitmproxy.org/api/docs-master-brightgreen.svg .. |mitmproxy_docs_master| image:: https://shields.mitmproxy.org/api/docs-master-brightgreen.svg
:target: https://docs.mitmproxy.org/master/ :target: https://docs.mitmproxy.org/master/
:alt: mitmproxy documentation master :alt: mitmproxy documentation master

View File

@ -11,8 +11,7 @@ menu:
The mitmproxy project's tools are a set of front-ends that expose common The mitmproxy project's tools are a set of front-ends that expose common
underlying functionality. underlying functionality.
**mitmproxy** is an interactive man-in-the-middle proxy for HTTP and HTTPS **mitmproxy** is an interactive, SSL/TLS-capable intercepting proxy with a console interface for HTTP/1, HTTP/2, and WebSockets.
with a console interface.
**mitmdump** is the command-line version of mitmproxy. Think tcpdump for HTTP. **mitmdump** is the command-line version of mitmproxy. Think tcpdump for HTTP.
@ -21,6 +20,9 @@ with a console interface.
Documentation, tutorials and distribution packages can be found on the Documentation, tutorials and distribution packages can be found on the
[mitmproxy website](https://mitmproxy.org). [mitmproxy website](https://mitmproxy.org).
Development information and our source code can be found in our
[GitHub repository](https://github.com/mitmproxy/mitmproxy).
## Features ## Features
@ -29,8 +31,7 @@ Documentation, tutorials and distribution packages can be found on the
- Replay the client-side of an HTTP conversations - Replay the client-side of an HTTP conversations
- Replay HTTP responses of a previously recorded server - Replay HTTP responses of a previously recorded server
- Reverse proxy mode to forward traffic to a specified server - Reverse proxy mode to forward traffic to a specified server
- Transparent proxy mode on OSX and Linux - Transparent proxy mode on macOS and Linux
- Make scripted changes to HTTP traffic using Python - Make scripted changes to HTTP traffic using Python
- SSL/TLS certificates for interception are generated on the fly - SSL/TLS certificates for interception are generated on the fly
- And much, much more... - And much, much more...

View File

@ -1,6 +1,6 @@
# mitmproxy # mitmproxy
Containerized version of [mitmproxy](https://mitmproxy.org/), an interactive SSL-capable intercepting HTTP proxy. Containerized version of [mitmproxy](https://mitmproxy.org/): an interactive, SSL/TLS-capable intercepting proxy for HTTP/1, HTTP/2, and WebSockets.
# Usage # Usage

View File

@ -18,7 +18,7 @@ with open(os.path.join(here, "mitmproxy", "version.py")) as f:
setup( setup(
name="mitmproxy", name="mitmproxy",
version=VERSION, version=VERSION,
description="An interactive, SSL-capable, man-in-the-middle HTTP proxy for penetration testers and software developers.", description="An interactive, SSL/TLS-capable intercepting proxy for HTTP/1, HTTP/2, and WebSockets.",
long_description=long_description, long_description=long_description,
url="http://mitmproxy.org", url="http://mitmproxy.org",
author="Aldo Cortesi", author="Aldo Cortesi",