Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #26

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
PCP client library
===================
Port Control Protocol (PCP) client library
==========================================

PCP client library implements client side of PCP
([RFC 6887](http://datatracker.ietf.org/doc/rfc6887/)) and
NATPMP([RFC 6886](http://tools.ietf.org/html/rfc6886)) protocols.
Switch to NATPMP is done automatically by version negotiation. This library
([RFC 6887](https://datatracker.ietf.org/doc/rfc6887/)) and
NAT-PMP ([RFC 6886](https://datatracker.ietf.org/doc/rfc6886/)) protocols.
Switch to NAT-PMP is done automatically by version negotiation. This library
enables any network application to manage network edge device (e.g. to create
NAT mapping or ask router for specific flow treatment).

Supported platforms are
Linux, MS Windows (Vista and later), OS X.
Linux, Microsoft Windows (Vista and later) and macOS.

### Components ###

- libpcp - PCP client library
- pcp_app - PCP client CLI app
- pcp_server - mock PCP server
- scapy - PCP layer for Scapy
- [libpcp](libpcp) - PCP client library
- [pcp_app](pcp_app) - PCP client CLI app
- [pcp_server](pcp_server) - Mock PCP server
- [scapy](scapy) - PCP layer for Scapy

Build instructions are located in INSTALL.md file. More information about
components are in each subdirectory's README.md file.
Expand Down