Skip to content

Commit 2735d8d

Browse files
committed
Update README.
1 parent e2968da commit 2735d8d

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,31 @@
1-
### Prebuilt examples for phpMussel.
1+
[![Join the chat at https://gitter.im/phpMussel2/Lobby](https://badges.gitter.im/phpMussel2/Lobby.svg)](https://gitter.im/phpMussel2/Lobby)
2+
[![v1: PHP >= 5.4.0](https://img.shields.io/badge/v1-PHP%20%3E%3D%205.4.0-8892bf.svg)](https://maikuolan.github.io/Compatibility-Charts/)
3+
[![v2~v3: PHP >= 7.2.0](https://img.shields.io/badge/v2%7Ev3-PHP%20%3E%3D%207.2.0-8892bf.svg)](https://maikuolan.github.io/Compatibility-Charts/)
4+
[![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
5+
[![PRs Welcome](https://img.shields.io/badge/PRs-Welcome-brightgreen.svg)](http://makeapullrequest.com)
26

3-
(See ZIPs attached to the tags at this repository).
7+
## **What is phpMussel?**
8+
9+
An ideal solution for shared hosting environments, where it's often not possible to utilise or install conventional anti-virus protection solutions, phpMussel is a PHP script designed to **detect trojans, viruses, malware and other threats** within files uploaded to your system wherever the script is hooked, based on the signatures of [ClamAV](https://www.clamav.net/) and others. For information regarding *HOW TO INSTALL* {2A+2B} and *HOW TO USE* {3A+3B} phpMussel, please refer either to the [Wiki](https://github.com/phpMussel/phpMussel/wiki) or to the [documentation](https://github.com/phpMussel/Docs/tree/master) (direct links to that documentation included under the "Documentation" header below this paragraph).
10+
11+
---
12+
13+
14+
### What's this repository for?
15+
16+
This repository contains prebuilt examples for phpMussel (see ZIPs attached to the tags at this repository).
17+
18+
#### See also:
19+
- [phpMussel/phpMussel](https://github.com/phpMussel/phpMussel) – The main phpMussel repository (you can get phpMussel versions prior to v3 from here).
20+
- [phpMussel/Core](https://github.com/phpMussel/Core) – phpMussel core (dedicated Composer version).
21+
- [phpMussel/CLI](https://github.com/phpMussel/CLI) – phpMussel CLI-mode (dedicated Composer version).
22+
- [phpMussel/FrontEnd](https://github.com/phpMussel/FrontEnd) – phpMussel front-end (dedicated Composer version).
23+
- [phpMussel/Web](https://github.com/phpMussel/Web) – phpMussel upload handler (dedicated Composer version).
24+
- [phpMussel/Examples](https://github.com/phpMussel/Examples) – Prebuilt examples for phpMussel (useful for users which don't want to use Composer to install phpMussel).
25+
- [phpMussel/plugin-boilerplates](https://github.com/phpMussel/plugin-boilerplates) – This repository contains boilerplate code which can be used to create new plugins for phpMussel.
26+
- [phpMussel/Plugin-PHPMailer](https://github.com/phpMussel/Plugin-PHPMailer) – Provides 2FA and email notifications support for phpMussel v3+.
27+
28+
---
29+
30+
31+
Last Updated: 6 July 2020 (2020.07.06).

0 commit comments

Comments
 (0)