Skip to content

Commit 4716d19

Browse files
MaikuolanMaikuolan
committed
Update README.
1 parent bccb064 commit 4716d19

File tree

1 file changed

+43
-45
lines changed

1 file changed

+43
-45
lines changed

‎README.md

+43-45
Original file line numberDiff line numberDiff line change
@@ -11,59 +11,57 @@ An ideal solution for shared hosting environments, where it's often not possible
1111
---
1212

1313

14-
### Features:
15-
- Licensed as [GNU General Public License version 2.0](https://github.com/phpMussel/phpMussel/blob/v2/LICENSE.txt) (GPLv2).
16-
- Easy to install, easy to customise, easy to use.
17-
- Works for any system with PHP+PCRE installed, regardless of OS (PHP+PCRE required).
18-
- Fully configurable based on your needs.
19-
- Ideal solution for shared hosting services.
20-
- Ideal solution for forum systems in need of file upload protection.
21-
- Does NOT require shell access.
22-
- Does NOT require administrative privileges.
23-
- CLI mode available.
24-
- Good, strong, stable support base.
14+
### What's this repository for?
2515

26-
---
16+
This provides automatic file upload scanning to your website.
2717

18+
```
19+
composer require phpmussel/web
20+
```
2821

29-
### Documentation:
30-
- **[English](https://github.com/phpMussel/Docs/blob/master/readme.en.md)**
31-
- **[العربية](https://github.com/phpMussel/Docs/blob/master/readme.ar.md)**
32-
- **[Deutsch](https://github.com/phpMussel/Docs/blob/master/readme.de.md)**
33-
- **[Español](https://github.com/phpMussel/Docs/blob/master/readme.es.md)**
34-
- **[Français](https://github.com/phpMussel/Docs/blob/master/readme.fr.md)**
35-
- **[Bahasa Indonesia](https://github.com/phpMussel/Docs/blob/master/readme.id.md)**
36-
- **[Italiano](https://github.com/phpMussel/Docs/blob/master/readme.it.md)**
37-
- **[日本語](https://github.com/phpMussel/Docs/blob/master/readme.ja.md)**
38-
- **[한국어](https://github.com/phpMussel/Docs/blob/master/readme.ko.md)**
39-
- **[Nederlandse](https://github.com/phpMussel/Docs/blob/master/readme.nl.md)**
40-
- **[Português](https://github.com/phpMussel/Docs/blob/master/readme.pt.md)**
41-
- **[Русский](https://github.com/phpMussel/Docs/blob/master/readme.ru.md)**
42-
- **[اردو](https://github.com/phpMussel/Docs/blob/master/readme.ur.md)**
43-
- **[Tiếng Việt](https://github.com/phpMussel/Docs/blob/master/readme.vi.md)**
44-
- **[中文（简体）](https://github.com/phpMussel/Docs/blob/master/readme.zh.md)**
45-
- **[中文（傳統）](https://github.com/phpMussel/Docs/blob/master/readme.zh-tw.md)**
46-
47-
[\[CONTRIBUTING.md\] **Want to help?**](https://github.com/phpMussel/.github/blob/master/CONTRIBUTING.md)
48-
49-
[\[PEOPLE.md\] **Learn about the people behind phpMussel.**](https://github.com/phpMussel/.github/blob/master/PEOPLE.md)
22+
__*Example:*__
23+
```PHP
24+
<?php
25+
// Path to vendor directory.
26+
$Vendor = __DIR__ . DIRECTORY_SEPARATOR . 'vendor';
5027

51-
---
28+
// Composer's autoloader.
29+
require $Vendor . DIRECTORY_SEPARATOR . 'autoload.php';
30+
31+
$Loader = new \phpMussel\Core\Loader();
32+
$Scanner = new \phpMussel\Core\Scanner($Loader);
33+
$Web = new \phpMussel\Web\Web($Loader, $Scanner);
34+
35+
$Web->scan();
36+
37+
unset($Web, $Scanner, $Loader);
38+
39+
?><html>
40+
<form enctype="multipart/form-data" name="upload" action="" method="post">
41+
<div class="spanner">
42+
<input type="file" name="upload_test[]" value="" />
43+
<input type="submit" value="OK" />
44+
</div>
45+
</form>
46+
</html>
47+
```
5248

49+
*(And, after using that form to try uploading `ascii_standard_testfile.txt`, a benign sample provided for the sole purpose of testing phpMussel)…*
5350

54-
### Current major version development status:
51+
__*Screenshot:*__
52+
![Screenshot](https://raw.githubusercontent.com/phpMussel/extras/master/screenshots/web-v3.0.0-alpha2.png)
5553

56-
⬇Stage reached⬇ ➡Major version➡ | v0 | v1-v2 | v3
57-
:--|:-:|:-:|:-:
58-
Pre-Alpha<em><br />- Exploring early concepts/ideas. No code written/available yet.</em> | ✔ | ✔ | ✔
59-
Alpha<em><br />- Branched, but unstable. Not production-ready (high risk if used).</em> | ✔ | ✔ | ✔
60-
Beta<em><br />- Branched, but unstable. Not production-ready (low risk if used).</em> | ✔ | ✔
61-
Stable<em><br />- First production-ready version has been tagged/released.</em> | ✔ | ✔
62-
Mature<em><br />- Multiple stable versions/releases exist.</em> | ✔ | ✔
63-
Locked<em><br />- Still maintained, but new features won't be implemented anymore.</em> | ✔
64-
EoL/Dead<em><br />- Not maintained anymore. If possible, stop using, and update ASAP.</em> | ✔
54+
#### See also:
55+
- [phpMussel/phpMussel](https://github.com/phpMussel/phpMussel) – The main phpMussel repository (you can get phpMussel versions prior to v3 from here).
56+
- [phpMussel/Core](https://github.com/phpMussel/Core) – phpMussel core (dedicated Composer version).
57+
- [phpMussel/CLI](https://github.com/phpMussel/CLI) – phpMussel CLI-mode (dedicated Composer version).
58+
- [phpMussel/FrontEnd](https://github.com/phpMussel/FrontEnd) – phpMussel front-end (dedicated Composer version).
59+
- [phpMussel/Web](https://github.com/phpMussel/Web) – phpMussel upload handler (dedicated Composer version).
60+
- [phpMussel/Examples](https://github.com/phpMussel/Examples) – Prebuilt examples for phpMussel (useful for users which don't want to use Composer to install phpMussel).
61+
- [phpMussel/plugin-boilerplates](https://github.com/phpMussel/plugin-boilerplates) – This repository contains boilerplate code which can be used to create new plugins for phpMussel.
62+
- [phpMussel/Plugin-PHPMailer](https://github.com/phpMussel/Plugin-PHPMailer) – Provides 2FA and email notifications support for phpMussel v3+.
6563

6664
---
6765

6866

69-
Last Updated: 10 June 2020 (2020.06.10).
67+
Last Updated: 6 July 2020 (2020.07.06).

0 commit comments

Comments
 (0)