Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
pixelpeter committed Nov 17, 2016
1 parent 62fe501 commit f147990
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 5 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

All Notable changes for the Laravel 5 WooCommerce REST API Client will be documented in this file

## 2.1.0
- Add additional configuration vallues (Thanks to ebisbe)
- Update README.md

## 2.0.0
- Add support for Woocommerce 2.6+ (Thanks to leeroyrose)

Expand Down
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,22 @@ Add the alias in `app/config/app.php`
];
```

### Step 4: Customize configuration
### Step 4: Publish configuration
``` bash
php artisan vendor:publish --provider="Pixelpeter\Woocommerce\WoocommerceServiceProvider"
```

### Step 5: Customize configuration
You can directly edit the configuration in `config/woocommerce.php` or copy these values to your `.env` file.
```php
WOOCOMMERCE_STORE_URL=http://example.org
WOOCOMMERCE_CONSUMER_KEY=ck_your-consumer-key
WOOCOMMERCE_CONSUMER_SECRET=cs_your-consumer-secret
WOOCOMMERCE_VERIFY_SSL=false
WOOCOMMERCE_VERSION=v3
WOOCOMMERCE_VERSION=v1
WOOCOMMERCE_WP_API=true
WOOCOMMERCE_WP_QUERY_STRING_AUTH=false
WOOCOMMERCE_WP_TIMEOUT=15
```

## Examples
Expand Down Expand Up @@ -114,7 +122,7 @@ return Woocommerce::put('products/1', $data);
```

### More Examples
Refer to [WooCommerce REST API Documentation](woothemes.github.io/woocommerce-rest-api-docs/) for more examples and documention.
Refer to [WooCommerce REST API Documentation](https://woocommerce.github.io/woocommerce-rest-api-docs) for more examples and documention.

## Testing
Run the tests with:
Expand Down
4 changes: 2 additions & 2 deletions config/woocommerce.php
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,14 @@

/*
|--------------------------------------------------------------------------
| WP API usage
| Force Basic Authentication as query string
|--------------------------------------------------------------------------
*/
'query_string_auth' => env('WOOCOMMERCE_WP_QUERY_STRING_AUTH', false),

/*
|--------------------------------------------------------------------------
| WP API usage
| WP timeout
|--------------------------------------------------------------------------
*/
'timeout' => env('WOOCOMMERCE_WP_TIMEOUT', 15),
Expand Down

0 comments on commit f147990

Please sign in to comment.