summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorjvoisin2017-09-20 10:38:24 +0200
committerjvoisin2017-09-20 10:38:24 +0200
commit3182dd8af96a947e44b5cf4e023e7d1e654342aa (patch)
tree7bc4b5bd253a77db355d505bc5ff638eb8dd7c24 /README.md
parent58b15eb9cf37ba7e5df7c85aabdb6988de012ab7 (diff)
Bump the readme
Diffstat (limited to '')
-rw-r--r--README.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/README.md b/README.md
index 3470c9a..6180202 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,15 @@
1# ALPHA SOFTWARE : DO NOT USE IN PRODUCTION # 1# ALPHA SOFTWARE : DO NOT USE IN PRODUCTION #
2 2
3Snuffleupagus is a [PHP 7+](https://secure.php.net/) module designed to
4drastically raising the cost of attacks against website, by killing entire bug
5classes, and also providing a powerful virtual-patching system, allowing
6administrator to fix specific vulnerabilities and audit suspicious behaviours
7without having to touch the PHP code.
8
9You can read its documentation [here](https://snuffleupagus.readthedocs.io/).
10
3# Code style 11# Code style
12
4We're using [clang-format](http://clang.llvm.org/docs/ClangFormat.html) to 13We're using [clang-format](http://clang.llvm.org/docs/ClangFormat.html) to
5ensure a consistent code-style. Please run it with `clang-format -style=google` 14ensure a consistent code-style. Please run it with `clang-format -style=google`
6before committing, or even better, use a [pre-commit hook](https://github.com/andrewseidl/githook-clang-format) 15before committing, or even better, use a [pre-commit hook](https://github.com/andrewseidl/githook-clang-format)
7
8# Resources
9- The [writeup]( https://github.com/beberlei/whitewashing.de/blob/master/drafts/porting_extension_to_php7.rst) of [tideway profiler](https://github.com/tideways/php-profiler-extension)'s port to php7
10- [Upgrading to php-ng]( https://wiki.php.net/phpng-upgrading )
11- PHP7 [virtual machine](https://nikic.github.io/2017/04/14/PHP-7-Virtual-machine.html)