Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
FGasper committed Dec 21, 2022
1 parent f4aa534 commit f385158
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ Net::mbedTLS - [mbedTLS](https://tls.mbed.org/) in Perl

# DESCRIPTION

[OpenSSL](https://openssl.org) is great, and so is [Net::SSLeay](https://metacpan.org/pod/Net%3A%3ASSLeay),
its Perl binding. Both are rather large, though.
[OpenSSL](https://openssl.org) is great but rather large.

This distribution allows use of mbedTLS, a smaller, simpler TLS library,
from Perl.
Expand All @@ -41,7 +40,7 @@ This library, like mbedTLS itself, minimizes memory usage at
the cost of performance. After a simple TLS handshake with this library
Perl’s memory usage is about 6.5 MiB lower than when using
[IO::Socket::SSL](https://metacpan.org/pod/IO%3A%3ASocket%3A%3ASSL) for the same. On the other hand, OpenSSL does the
handshake about 18 times faster.
handshake (as of this writing) about 18 times faster.

# AVAILABLE FUNCTIONALITY

Expand All @@ -63,6 +62,10 @@ contains mbedTLS’s `include` and `lib` (or `library`) directories.
- Static, to a specific path: Like the previous one, but
also set `NET_MBEDTLS_LINKING` to `static` in your environment.

NB: In the latter two cases your compiler has to generate
_position-independent_ code when building mbedTLS. GCC’s `-fPIC`
flag does this. (See this distribution’s CI tests for an example.)

Dynamic linking allows Net::mbedTLS to use the most recent
(compatible) mbedTLS but requires you to have a shared mbedTLS
available, whereas static linking alleviates that dependency at the
Expand Down
5 changes: 2 additions & 3 deletions lib/Net/mbedTLS.pm
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,7 @@ Net::mbedTLS - L<mbedTLS|https://tls.mbed.org/> in Perl
=head1 DESCRIPTION
L<OpenSSL|https://openssl.org> is great, and so is L<Net::SSLeay>,
its Perl binding. Both are rather large, though.
L<OpenSSL|https://openssl.org> is great but rather large.
This distribution allows use of mbedTLS, a smaller, simpler TLS library,
from Perl.
Expand All @@ -57,7 +56,7 @@ This library, like mbedTLS itself, minimizes memory usage at
the cost of performance. After a simple TLS handshake with this library
Perl’s memory usage is about 6.5 MiB lower than when using
L<IO::Socket::SSL> for the same. On the other hand, OpenSSL does the
handshake about 18 times faster.
handshake (as of this writing) about 18 times faster.
=head1 AVAILABLE FUNCTIONALITY
Expand Down

0 comments on commit f385158

Please sign in to comment.