Skip to content

Commit 8aba4a2

Browse files
authored
Update README.md
1 parent dcba70f commit 8aba4a2

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
# Yaf - Yet Another Framework
22
[![Build status](https://ci.appveyor.com/api/projects/status/awii6wf2ocmy202p/branch/master?svg=true)](https://ci.appveyor.com/project/laruence/yaf/branch/master) [![Build Status](https://github.com/laruence/yaf/workflows/integrate/badge.svg)](https://github.com/laruence/yaf/actions?query=workflow%3Aintegrate)
33

4-
PHP framework written in c and built as a PHP extension.
4+
Yaf is a PHP framework with high performance, it is written in c and built as a PHP extension
55

66
## Requirement
77
- PHP 7.0+ (master branch))
88
- PHP 5.2+ ([php5 branch](https://github.com/laruence/yaf/tree/php5))
99

1010
## Install
1111
### Install Yaf
12-
Yaf is a PECL extension, thus you can simply install it by:
12+
Yaf is a PECL extension, which means you can simply install it by:
1313

1414
```
1515
$pecl install yaf
1616
```
1717
### Compile Yaf in Linux
18+
Of course, you could also install it by hand:
1819
```
1920
$/path/to/phpize
2021
$./configure --with-php-config=/path/to/php-config
@@ -24,16 +25,14 @@ $make && make install
2425
## Document
2526
Yaf manual could be found at: http://www.php.net/manual/en/book.yaf.php
2627

27-
## IRC
28-
efnet.org #php.yaf
2928

3029
## For IDE
31-
You could find a documented prototype script here: https://github.com/elad-yosifon/php-yaf-doc
30+
A documented prototype script could be found at: https://github.com/elad-yosifon/php-yaf-doc
3231

3332
## Tutorial
3433

3534
### layout
36-
A classic application directory layout:
35+
A classic application directory layout is:
3736

3837
```
3938
- .htaccess // Rewrite rules
@@ -56,7 +55,7 @@ A classic application directory layout:
5655
+ plugins // Plugins
5756
```
5857
### DocumentRoot
59-
You should set `DocumentRoot` to `application/public`, thus only the public folder can be accessed by user
58+
You should set `DocumentRoot` to `application/public`, by doing this, only the public folder can be accessed by user:
6059

6160
### index.php
6261
`index.php` in the public directory is the only way in of the application, you should rewrite all request to it(you can use `.htaccess` in Apache+php mod)
@@ -140,7 +139,7 @@ class IndexController extends Yaf_Controller_Abstract {
140139
```
141140

142141
### view script
143-
The view script for default controller and default action is in the application/views/index/index.phtml, Yaf provides a simple view engine called "Yaf_View_Simple", which support the view template written in PHP.
142+
The view script for default controller and default action is application/views/index/index.phtml, Yaf provides a simple view engine called "Yaf_View_Simple", which support the view template written in PHP:
144143

145144
```php
146145
<html>
@@ -154,7 +153,8 @@ The view script for default controller and default action is in the application/
154153
```
155154

156155
## Run the Application
157-
http://www.example.com
156+
157+
http://www.example.com
158158

159159
## Alternative
160160
You can generate the example above by using Yaf Code Generator: https://github.com/laruence/php-yaf/tree/master/tools/cg
@@ -163,4 +163,4 @@ You can generate the example above by using Yaf Code Generator: https://github.
163163
```
164164

165165
## More
166-
More info could be found at Yaf Manual: http://www.php.net/manual/en/book.yaf.php
166+
More infos could be found at Yaf Manual: http://www.php.net/manual/en/book.yaf.php

0 commit comments

Comments
 (0)