Error202
/
yii2-swiftmailer
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

fixed readme

tags/2.0.0-beta
Qiang Xue 11 years ago
parent
c7c13a6693
commit
8245e574d9
3 changed files with 48 additions and 47 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 38
      README.md
  2. 30
      extensions/sphinx/README.md
  3. 27
      framework/README.md

38
README.md
Unescape View File

@ -1,13 +1,22 @@
Yii 2.0 Public Preview Yii PHP Framework Version 2
====================== ===========================
Thank you for choosing Yii - a high-performance component-based PHP framework. Thank you for choosing Yii 2 - a modern PHP framework designed for professional Web development.
If you are looking for a production-ready PHP framework, please use Yii 2 is a complete rewrite of its previous version Yii 1.1 which is one of the most popular PHP frameworks.
[Yii v1.1](https://github.com/yiisoft/yii). Yii 2 inherits the main spirit behind Yii for being simple, fast and highly extensible.
Yii 2 requires PHP 5.4 and embraces best practices and protocols found in modern Web application development.
**Yii 2 is not ready for production use yet.** We may make significant changes without prior notices.
We expect to make the first stable release of Yii 2 in early 2014.
If you mainly want to learn Yii with no real project development requirement, we highly recommend
you start with Yii 2 as it will be our main focus for the next few years.
If you have a real project with tight schedule, you should stick to [Yii 1.1](https://github.com/yiisoft/yii)
which is the latest stable release of Yii.
Yii 2.0 is still under heavy development. We may make significant changes
without prior notices. **Yii 2.0 is not ready for production use yet.**
[![Latest Stable Version](https://poser.pugx.org/yiisoft/yii2/v/stable.png)](https://packagist.org/packages/yiisoft/yii2) [![Latest Stable Version](https://poser.pugx.org/yiisoft/yii2/v/stable.png)](https://packagist.org/packages/yiisoft/yii2)
[![Total Downloads](https://poser.pugx.org/yiisoft/yii2/downloads.png)](https://packagist.org/packages/yiisoft/yii2) [![Total Downloads](https://poser.pugx.org/yiisoft/yii2/downloads.png)](https://packagist.org/packages/yiisoft/yii2)
@ -18,15 +27,14 @@ without prior notices. **Yii 2.0 is not ready for production use yet.**
DIRECTORY STRUCTURE DIRECTORY STRUCTURE
------------------- -------------------
apps/ ready-to-use Web apps built on Yii 2 apps/ ready-to-use application templates
advanced/ advanced app template with complex features advanced/ a template suitable for building sophisticated Web applications
basic/ a simple app supporting user login and contact page basic/ a template suitable for building simple Web applications
benchmark/ app demonstrating the minimal overhead introduced by the framework benchmark/ an application demonstrating the performance of Yii
build/ internally used build tools build/ internally used build tools
docs/ documentation docs/ documentation
extensions/ extensions extensions/ extensions
framework/ framework files framework/ core framework code
yii/ framework source files
tests/ tests of the core framework code tests/ tests of the core framework code
@ -39,11 +47,11 @@ The minimum requirement by Yii is that your Web server supports PHP 5.4.
DOCUMENTATION DOCUMENTATION
------------- -------------
A draft of the [Definitive Guide](docs/guide/index.md) is available.
For 1.1 users, you may refer to [Upgrading from Yii 1.1](docs/guide/upgrade-from-v1.md) For 1.1 users, you may refer to [Upgrading from Yii 1.1](docs/guide/upgrade-from-v1.md)
to have a general idea of what has changed in 2.0. to have a general idea of what has changed in 2.0.
[Definitive Guide draft](docs/guide/index.md) is available. It's not complete yet but main parts are already OK.
HOW TO PARTICIPATE HOW TO PARTICIPATE
------------------ ------------------

30
extensions/sphinx/README.md
Unescape View File

@ -1,17 +1,7 @@
Yii 2.0 Public Preview - Sphinx Extension Sphinx Extension for Yii 2
========================================= ==========================
Thank you for choosing Yii - a high-performance component-based PHP framework. This extension adds [Sphinx](http://sphinxsearch.com/docs) full text search engine extension for the Yii 2 framework.
If you are looking for a production-ready PHP framework, please use
[Yii v1.1](https://github.com/yiisoft/yii).
Yii 2.0 is still under heavy development. We may make significant changes
without prior notices. **Yii 2.0 is not ready for production use yet.**
[![Build Status](https://secure.travis-ci.org/yiisoft/yii2.png)](http://travis-ci.org/yiisoft/yii2)
This is the yii2-sphinx extension.
Installation Installation
@ -20,26 +10,26 @@ Installation
The preferred way to install this extension is through [composer](http://getcomposer.org/download/). The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run Either run
``` ```
php composer.phar require yiisoft/yii2-sphinx "*" php composer.phar require yiisoft/yii2-sphinx "*"
``` ```
or add or add
```
```json
"yiisoft/yii2-sphinx": "*" "yiisoft/yii2-sphinx": "*"
``` ```
to the require section of your composer.json.
*Note: You might have to run `php composer.phar selfupdate`* to the require section of your composer.json.
Usage & Documentation Usage & Documentation
--------------------- ---------------------
This extension adds [Sphinx](http://sphinxsearch.com/docs) full text search engine extension for the Yii framework. This extension interacts with Sphinx search daemon using MySQL protocol and [SphinxQL](http://sphinxsearch.com/docs/current.html#sphinxql) query language.
This extension interact with Sphinx search daemon using MySQL protocol and [SphinxQL](http://sphinxsearch.com/docs/current.html#sphinxql) query language.
In order to setup Sphinx "searchd" to support MySQL protocol following configuration should be added: In order to setup Sphinx "searchd" to support MySQL protocol following configuration should be added:
``` ```
searchd searchd
{ {
@ -115,4 +105,4 @@ $provider = new ActiveDataProvider([
] ]
]); ]);
$models = $provider->getModels(); $models = $provider->getModels();
``` ```

27
framework/README.md
Unescape View File

@ -1,21 +1,24 @@
Yii 2.0 Public Preview Yii PHP Framework Version 2
====================== ===========================
Thank you for choosing Yii - a high-performance component-based PHP framework. This is the core framework code of [Yii 2](https://github.com/yiisoft/yii2).
If you are looking for a production-ready PHP framework, please use
[Yii v1.1](https://github.com/yiisoft/yii).
Yii 2.0 is still under heavy development. We may make significant changes Installation
without prior notices. **Yii 2.0 is not ready for production use yet.** ------------
[![Build Status](https://secure.travis-ci.org/yiisoft/yii2.png)](http://travis-ci.org/yiisoft/yii2)
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
REQUIREMENTS ```
------------ php composer.phar require yiisoft/yii2-framework "*"
```
The minimum requirement by Yii is that your Web server supports PHP 5.4.0. or add
```json
"yiisoft/yii2-framework": "*"
```
to the require section of your composer.json.

Write Preview
Loading…
Cancel
Save