From 2ad5f85197e46315152a3def7ce694d992541d82 Mon Sep 17 00:00:00 2001 From: Oliver Klee Date: Wed, 24 May 2017 12:40:40 +0200 Subject: [PATCH 1/2] [TASK] Add a package description to the README --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index a1a976b7..c34c06c3 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,27 @@ [![License](https://poser.pugx.org/phplist/phplist4-core/license.svg)](https://packagist.org/packages/phpList/phpList) +## About phpList + + PhpList is an open source newsletter manager. This project is a rewrite of the [original phpList](https://github.com/phpList/phplist3). +## About this package + +This is the phpList 4 core. It will have the following responsibilities: + +* provide access to the DB via Doctrine models and repositories (and raw SQL + for performance-critical parts that do not need the models) +* routing (which the web frontend and REST API will use) +* authentication (which the web frontend and REST API will use) +* logging +* a script for tasks to be called from the command line (or a cron job) +* tasks to create and update the DB schema + +This package should not be modified locally. It should be updated via Composer. + ## Copyright PhpList is copyright (C) 2000-2017 Michiel Dethmers, From e5ff94d97cb1385a1f5bd8670ca2d315d62f2088 Mon Sep 17 00:00:00 2001 From: Sam Tuke Date: Wed, 24 May 2017 12:48:52 +0200 Subject: [PATCH 2/2] Update README.md Minor fixes to copyright section -- capitalisation and copyright assignment to phpList Ltd. --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index c34c06c3..453766ea 100644 --- a/README.md +++ b/README.md @@ -31,5 +31,4 @@ This package should not be modified locally. It should be updated via Composer. ## Copyright -PhpList is copyright (C) 2000-2017 Michiel Dethmers, -[phpList Ltd](http://www.phplist.com/). +phpList is copyright (C) 2000-2017 [phpList Ltd](http://www.phplist.com/).