From 6e5db41a1cce5276d41e29b0e7c1d60ccab1c03a Mon Sep 17 00:00:00 2001 From: gdarko Date: Thu, 25 Jun 2020 20:41:43 +0000 Subject: [PATCH] Update readme --- README.md | 27 +++++++++------------------ 1 file changed, 9 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 046d446..36ee489 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,21 @@ -# Eloquent Wrapper for WordPress +# ORM for WordPress -This is a fork of the `wp-eloquent` [Laravel Eloquent](http://laravel.com/docs/5.0/eloquent) wrapper for WordPress. +Laravel Eloquent based ORM for WordPress + +This is a fork of the original library written by [Tareq Hasan](https://tareq.co) with some more improvements and changes. -The aim of this fork is to add additional functionality and provide regular maintenance - ## Package Installation -To install this package, edit your `composer.json` file: +To install the library run: -```js -{ - "require": { - "gdarko/wp-orm":"dev-master" - } -} +``` +composer require gdarko/wp-orm ``` -Now run: - -`$ composer install` - -# Usage Example +## Usage Example -## Basic Usage +### Basic Usage ```php @@ -161,4 +153,3 @@ var_dump(Post::type('page')->status('publish')->get()->toArray()); // get pages ## Author - [Darko Gjorgjijoski](https://darkog.com) -- [Tareq Hasan](https://tareq.co)