Skip to content

Commit 23aa5d7

Browse files
committed
Improved README and Docs
1 parent 3176111 commit 23aa5d7

File tree

4 files changed

+27
-15
lines changed

4 files changed

+27
-15
lines changed

CHANGELOG.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Change Log
2626

2727
* **Fixed multiple install command execution (Now admin and project group don't duplicate).**
2828
* Added yaml highlight for build config in project page.
29-
* Improved Gogs support. Thanks to @vinpel. PullRequest #18.
29+
* Improved Gogs support. Thanks to [@vinpel](https://github.com/vinpel). PullRequest #18.
3030
* Improved dashboard UI.
3131

3232

@@ -56,9 +56,9 @@ cd ./php-censor.local
5656
```
5757

5858
* Added caching for public build status badge. Issue #15.
59-
* Added build from Gogs (build type and webhook). The feature is based on @denji`s code. Issue #13.
60-
* Improved Codeception plugin. Thanks to @vinpel. PullRequest #16.
61-
* Updated french translation. Thanks to @vinpel. PullRequest #16.
59+
* Added build from Gogs (build type and webhook). The feature is based on [@denji](https://github.com/denji)'s code. Issue #13.
60+
* Improved Codeception plugin. Thanks to [@vinpel](https://github.com/vinpel). PullRequest #16.
61+
* Updated french translation. Thanks to [@vinpel](https://github.com/vinpel). PullRequest #16.
6262
* Fixed init language. Issue #9.
6363

6464

@@ -147,7 +147,8 @@ php-censor:
147147
mail_attribute: mail
148148
```
149149

150-
If you enter by new LDAP-user, the record in the DB will be created automatically. The basement of the feature is @Adirelle and @dzolotov code.
150+
If you enter by new LDAP-user, the record in the DB will be created automatically. The basement of the feature is
151+
[@Adirelle](https://github.com/Adirelle) and [@dzolotov](https://github.com/dzolotov) code.
151152

152153
* **Unified application configuration (app/config.yml) authentication options**
153154

README.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -29,24 +29,25 @@ More [screenshots](docs/en/screenshots.md).
2929
System requirements
3030
-------------------
3131

32-
* Unix-like OS (**Windows isn't supported**)
32+
* Unix-like OS (**Windows isn't supported**);
3333

34-
* PHP 5.6+ (with OpenSSL support and enabled functions: `exec()`, `shell_exec()` and `proc_open()`)
34+
* PHP 5.6+ (with OpenSSL support and enabled functions: `exec()`, `shell_exec()` and `proc_open()`);
3535

36-
* Web-server (Nginx or Apache2)
36+
* Web-server (Nginx or Apache2);
3737

38-
* Database (MySQL/MariaDB or PostgreSQL)
38+
* Database (MySQL/MariaDB or PostgreSQL);
3939

40-
* Beanstalkd queue (Optional)
40+
* Beanstalkd queue (Optional);
4141

4242
Features
4343
--------
4444

4545
* Clone project from Github, Bitbucket, Gitlab, Git, Mercurial, SVN or from local directory;
4646

47-
* Set up and tear down database tests for PostgreSQL, MySQL or SQLite;
47+
* Set up and tear down database tests for [PostgreSQL](docs/plugins/pgsql.md), [MySQL](docs/plugins/mysql.md) or
48+
[SQLite](docs/plugins/sqlite.md);
4849

49-
* Install Composer dependencies;
50+
* Install [Composer](docs/plugins/composer.md) dependencies;
5051

5152
* Run tests for PHPUnit, Atoum, Behat, Codeception and PHPSpec;
5253

@@ -56,7 +57,9 @@ PHPMessDetect, PHPTalLint and TechnicalDept;
5657
* Run through any combination of the other [supported plugins](docs/en/README.md), including Campfire, CleanBuild,
5758
CopyBuild, Deployer, Env, Git, Grunt, Gulp, PackageBuild, Phar, Phing, Shell and Wipe;
5859

59-
* Send notifications on Email, XMPP, Slack, IRC, Flowdock and HipChat;
60+
* Send notifications on Email, XMPP, Slack, IRC, Flowdock, HipChat and [Telegram](https://github.com/LEXASOFT/PHP-Censor-Telegram-Plugin);
61+
62+
* Use your LDAP-server for authentication;
6063

6164
Installing
6265
----------

docs/en/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ Using PHP Censor
2727
Plugins
2828
-------
2929

30+
### Internal plugins
31+
3032
* [Atoum](plugins/atoum.md) - `atoum`
3133
* [Behat](plugins/behat.md) - `behat`
3234
* [Campfire](plugins/campfire.md) - `campfire`
@@ -61,3 +63,7 @@ Plugins
6163
* [Slack](plugins/slack_notify.md) - `slack_notify`
6264
* [Technical Debt](plugins/technical_dept.md) - `technical_debt`
6365
* [XMPP](plugins/xmpp.md) - `xmpp`
66+
67+
### Third-party plugins
68+
69+
* [Telegram](https://github.com/LEXASOFT/PHP-Censor-Telegram-Plugin) - Telegram plugin by [@LEXASOFT](https://github.com/LEXASOFT)

docs/en/sources/github.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
Automatically building commits pushed to GitHub
22
===============================================
33

4-
If you would like your builds to run automatically whenever there is a commit or other similar activity in your GitHub repository, perform the following steps:
4+
If you would like your builds to run automatically whenever there is a commit or other similar activity in your GitHub
5+
repository, perform the following steps:
56

67
1. Log into PHP Censor.
78
2. Click on your GitHub project.
@@ -11,4 +12,5 @@ If you would like your builds to run automatically whenever there is a commit or
1112
6. Click on "Webhooks & Services".
1213
7. Add your web hook link you copied above, and specify when you would like it to run.
1314
8. Add the public key for the project in PHP Censor to the deploy keys for the repository on GitHub.
14-
9. Verify that the initial test delivery was successful. If not, make sure that your PHP Censor machine is reachable from the internet.
15+
9. Verify that the initial test delivery was successful. If not, make sure that your PHP Censor machine is reachable
16+
from the internet.

0 commit comments

Comments
 (0)