Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
catfan committed Oct 5, 2015
2 parents a65ad33 + 3708f63 commit 634bcef
Show file tree
Hide file tree
Showing 3 changed files with 117 additions and 86 deletions.
32 changes: 22 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

> The Lightest PHP database framework to accelerate development
### Main Features
## Main Features

* **Lightweight** - Only 20KB with one file.
* **Lightweight** - 20KB around with only one file.

* **Easy** - Extremely easy to learn and use, friendly construction.

Expand All @@ -18,10 +18,25 @@

* **Free** - Under MIT license, you can use it anywhere if you want.

### Get Started
## Get Started

### Install via composer

Add Medoo to composer.json configuration file.
```
$ composer require catfan/Medoo
```

And update the composer
```
$ composer update
```

```php
// Include Medoo
// If you installed via composer, just use this code to requrie autoloader on the top of your projects.
require 'vendor/autoload.php';

// Or if you just download the medoo.php into directory, require it with the correct path.
require_once 'medoo.php';

// Initialize
Expand All @@ -41,24 +56,21 @@ $database->insert('account', [
'age' => 25,
'lang' => ['en', 'fr', 'jp', 'cn']
]);

// Or initialize from file and then
$database = new medoo();
```

### Contribution Guides
## Contribution Guides

For most of time, Medoo is using develop branch for adding feature and fixing bug, and the branch will be merged into master branch while releasing a public version. For contribution, submit your code to the develop branch, and start a pull request into it.

On develop branch, each commits are started with `[fix]`, `[feature]` or `[update]` tag to indicate the change.

Keep it simple and keep it clear.

### License
## License

Medoo is under the MIT License.

### Links
## Links

* Official website: [http://medoo.in](http://medoo.in)

Expand Down
10 changes: 5 additions & 5 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@
"homepage": "http://medoo.in",
"license": "MIT",
"authors": [
{"name": "Angel Lai", "email": "angel.lai.cat@gmail.com"}
{"name": "Angel Lai", "email": "angel@catfan.me"}
],
"require": {
"php": ">=5.1",
"ext-pdo": "*"
},
"suggest": {
"ext-pdo-mysql": "For MySQL or MariaDB databases",
"ext-pdo_mysql": "For MySQL or MariaDB databases",
"ext-pdo_sqlsrv": "For MSSQL databases on Windows platform",
"ext-pdo_dblib": "For MSSQL or Sybase databases on Liunx/UNIX platform",
"ext-pdo_dblib": "For MSSQL or Sybase databases on Linux/UNIX platform",
"ext-pdo_oci": "For Oracle databases",
"ext-pdo-pqsql": "For PostgreSQL databases",
"ext-pdo-sqlite": "For SQLite databases"
"ext-pdo_pqsql": "For PostgreSQL databases",
"ext-pdo_sqlite": "For SQLite databases"
},
"autoload": {
"files": ["medoo.php"]
Expand Down
Loading

0 comments on commit 634bcef

Please sign in to comment.