Yii 2.0 Public Preview
======================

Thank you for choosing Yii - a high-performance component-based PHP 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.**

[![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)
[![Build Status](https://secure.travis-ci.org/yiisoft/yii2.png)](http://travis-ci.org/yiisoft/yii2)
[![Dependency Status](https://www.versioneye.com/php/yiisoft:yii2/dev-master/badge.png)](https://www.versioneye.com/php/yiisoft:yii2/dev-master)


DIRECTORY STRUCTURE
-------------------

      apps/                ready-to-use Web apps built on Yii 2
          advanced/        advanced app template with complex features
          basic/           a simple app supporting user login and contact page
          benchmark/       app demonstrating the minimal overhead introduced by the framework
      build/               internally used build tools
      docs/                documentation
      extensions/          extensions
      framework/           framework files
          yii/             framework source files
      tests/               tests of the core framework code


REQUIREMENTS
------------

The minimum requirement by Yii is that your Web server supports PHP 5.4.


DOCUMENTATION
-------------

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.

[Definitive Guide draft](docs/guide/index.md) is available. It's not complete yet but main parts are already OK.


HOW TO PARTICIPATE
------------------

**Your participation to Yii 2 development is very welcome!**

You may participate in the following ways:

* [Report issues](https://github.com/yiisoft/yii2/issues)
* [Give us feedback or start a design discussion](http://www.yiiframework.com/forum/index.php/forum/42-design-discussions-for-yii-20/)
* Fix issues, develop features, write/polish documentation
    - Before you start, please adopt an existing issue (labelled with "ready for adoption") or start a new one to avoid duplicated efforts.
    - Please submit a merge request after you finish development.

