From 46f3177cf143e14b6c93b20786bdc4f1d56ddaf0 Mon Sep 17 00:00:00 2001 From: Marcus Bointon Date: Mon, 17 Oct 2016 18:55:23 +0200 Subject: [PATCH] Note about example inclusion --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 31bd4dc1..2284a720 100644 --- a/README.md +++ b/README.md @@ -134,6 +134,8 @@ Start reading at the [GitHub wiki](https://github.com/PHPMailer/PHPMailer/wiki). Examples of how to use PHPMailer for common scenarios can be found in the [examples](https://github.com/PHPMailer/PHPMailer/tree/master/examples) folder. If you're looking for a good starting point, we recommend you start with [the Gmail example](https://github.com/PHPMailer/PHPMailer/tree/master/examples/gmail.phps). +Note that in order to reduce PHPMailer's deployed code footprint, the examples are no longer included if you load PHPMailer via composer or via [GitHub's zip file download](https://github.com/PHPMailer/PHPMailer/archive/master.zip), so you'll need to either clone the git repository or use the above links to get to the examples directly. + Complete generated API documentation is [available online](http://phpmailer.github.io/PHPMailer/). You can generate complete API-level documentation by running `phpdoc` in the top-level folder, and documentation will appear in teh `docs` folder, though you'll need to have [PHPDocumentor](http://www.phpdoc.org) installed. You may find [the unit tests](https://github.com/PHPMailer/PHPMailer/tree/master/test/phpmailerTest.php) a good source of how to do various operations such as encryption.