Skip to content

Commit d3e377c

Browse files
committed
Update README.
1 parent e1cd0ac commit d3e377c

File tree

1 file changed

+47
-10
lines changed

1 file changed

+47
-10
lines changed

README.md

Lines changed: 47 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## **What is phpMussel?**
88

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* and *HOW TO USE* 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).
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.
1010

1111
---
1212

@@ -38,17 +38,54 @@ unset($CLI, $Scanner, $Loader);
3838
__*Screenshot:*__
3939
![Screenshot](https://raw.githubusercontent.com/phpMussel/extras/master/screenshots/cli-v3.0.0-alpha2.png)
4040

41+
---
42+
43+
44+
### Documentation:
45+
- **[English](https://github.com/phpMussel/Docs/blob/master/readme.en.md)**
46+
- **[العربية](https://github.com/phpMussel/Docs/blob/master/readme.ar.md)**
47+
- **[Deutsch](https://github.com/phpMussel/Docs/blob/master/readme.de.md)**
48+
- **[Español](https://github.com/phpMussel/Docs/blob/master/readme.es.md)**
49+
- **[Français](https://github.com/phpMussel/Docs/blob/master/readme.fr.md)**
50+
- **[Bahasa Indonesia](https://github.com/phpMussel/Docs/blob/master/readme.id.md)**
51+
- **[Italiano](https://github.com/phpMussel/Docs/blob/master/readme.it.md)**
52+
- **[日本語](https://github.com/phpMussel/Docs/blob/master/readme.ja.md)**
53+
- **[한국어](https://github.com/phpMussel/Docs/blob/master/readme.ko.md)**
54+
- **[Nederlandse](https://github.com/phpMussel/Docs/blob/master/readme.nl.md)**
55+
- **[Português](https://github.com/phpMussel/Docs/blob/master/readme.pt.md)**
56+
- **[Русский](https://github.com/phpMussel/Docs/blob/master/readme.ru.md)**
57+
- **[اردو](https://github.com/phpMussel/Docs/blob/master/readme.ur.md)**
58+
- **[Tiếng Việt](https://github.com/phpMussel/Docs/blob/master/readme.vi.md)**
59+
- **[中文(简体)](https://github.com/phpMussel/Docs/blob/master/readme.zh.md)**
60+
- **[中文(傳統)](https://github.com/phpMussel/Docs/blob/master/readme.zh-tw.md)**
61+
4162
#### See also:
42-
- [phpMussel/phpMussel](https://github.com/phpMussel/phpMussel) – The main phpMussel repository (you can get phpMussel versions prior to v3 from here).
43-
- [phpMussel/Core](https://github.com/phpMussel/Core) – phpMussel core (dedicated Composer version).
44-
- [phpMussel/CLI](https://github.com/phpMussel/CLI) – phpMussel CLI-mode (dedicated Composer version).
45-
- [phpMussel/FrontEnd](https://github.com/phpMussel/FrontEnd) – phpMussel front-end (dedicated Composer version).
46-
- [phpMussel/Web](https://github.com/phpMussel/Web) – phpMussel upload handler (dedicated Composer version).
47-
- [phpMussel/Examples](https://github.com/phpMussel/Examples) – Prebuilt examples for phpMussel (useful for users which don't want to use Composer to install phpMussel).
48-
- [phpMussel/plugin-boilerplates](https://github.com/phpMussel/plugin-boilerplates) – This repository contains boilerplate code which can be used to create new plugins for phpMussel.
49-
- [phpMussel/Plugin-PHPMailer](https://github.com/phpMussel/Plugin-PHPMailer) – Provides 2FA and email notifications support for phpMussel v3+.
63+
- [**phpMussel/phpMussel**](https://github.com/phpMussel/phpMussel) – The main phpMussel repository (you can get phpMussel versions prior to v3 from here).
64+
- [**phpMussel/Core**](https://github.com/phpMussel/Core) – phpMussel core (dedicated Composer version).
65+
- [**phpMussel/CLI**](https://github.com/phpMussel/CLI) – phpMussel CLI-mode (dedicated Composer version).
66+
- [**phpMussel/FrontEnd**](https://github.com/phpMussel/FrontEnd) – phpMussel front-end (dedicated Composer version).
67+
- [**phpMussel/Web**](https://github.com/phpMussel/Web) – phpMussel upload handler (dedicated Composer version).
68+
- [**phpMussel/Examples**](https://github.com/phpMussel/Examples) – Prebuilt examples for phpMussel (useful for users which don't want to use Composer to install phpMussel).
69+
- [**phpMussel/plugin-boilerplates**](https://github.com/phpMussel/plugin-boilerplates) – This repository contains boilerplate code which can be used to create new plugins for phpMussel.
70+
- [**phpMussel/Plugin-PHPMailer**](https://github.com/phpMussel/Plugin-PHPMailer) – Provides 2FA and email notifications support for phpMussel v3+.
71+
- [**CONTRIBUTING.md**](https://github.com/phpMussel/.github/blob/master/CONTRIBUTING.md) – Contribution guidelines.
72+
73+
---
74+
75+
76+
### Current major version development status:
77+
78+
⬇Stage reached⬇ ➡Major version➡ | v0 | v1 | v2 | v3
79+
:--|:-:|:-:|:-:|:-:
80+
Pre-Alpha<em><br />- Exploring early concepts/ideas. No code written/available yet.</em> | ✔ | ✔ | ✔ | ✔
81+
Alpha<em><br />- Branched, but unstable. Not production-ready (high risk if used).</em> | ✔ | ✔ | ✔ | ✔
82+
Beta<em><br />- Branched, but unstable. Not production-ready (low risk if used).</em> | ✔ | ✔ | ✔ | ✔
83+
Stable<em><br />- First production-ready version has been tagged/released.</em> | ✔ | ✔ | ✔ | ✔
84+
Mature<em><br />- Multiple stable versions/releases exist.</em> | ✔ | ✔ | ✔
85+
Locked<em><br />- Still maintained, but new features won't be implemented anymore.</em> | ✔ | ✔
86+
EoL/Dead<em><br />- Not maintained anymore. If possible, stop using, and update ASAP.</em> | ✔
5087

5188
---
5289

5390

54-
Last Updated: 20 July 2020 (2020.07.20).
91+
Last Updated: 16 October 2020 (2020.10.16).

0 commit comments

Comments
 (0)