Skip to content

Updating installation directions to use 'composer require lildude/phpsmug' #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 10, 2016
Merged

Updating installation directions to use 'composer require lildude/phpsmug' #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6c5721
Updating installation directions to use 'composer require lildude/php…
elcontraption Feb 10, 2016
daeda59
Updating installation instructions to match README
elcontraption Feb 10, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 10 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,34 +17,30 @@ The intention of this class is to allow PHP application developers quick and eas

## Installation

The recommended method of installing phpSmug is using [Composer](http://getcomposer.org) by adding the following to your project's `composer.json`:
The recommended method of installing phpSmug is using [Composer](http://getcomposer.org). If you have Composer installed, you can install phpSmug and all its dependencies from within your project directory:

```bash
$ composer require lildude/phpsmug
```

Alternatively, you can add the following to your project's `composer.json`:

```json
{
"require": {
"guzzlehttp/oauth-subscriber": "0.3.*"
"lildude/phpsmug": "^4.0"
}
}
```

.. and then run `composer update` from within your project directory.

If you don't have Composer installed, you can download it using:

```bash
$ curl -s http://getcomposer.org/installer | php
```

.. and then use it to install phpSmug and all dependencies using:

```bash
$ php composer.phar install
```

If you have Composer installed, you can install phpSmug run the following from within your project directory:

```bash
$ composer install
```

## Basic Usage of the phpSmug Client

`phpSmug` follows the PSR-1, PSR-2 and PSR-4 conventions, which means you can easily use Composer's [autoloading](https://getcomposer.org/doc/01-basic-usage.md#autoloading) to integrate `phpSmug` into your projects.
Expand Down
24 changes: 10 additions & 14 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,26 @@

# Installation

The recommended method of installing phpSmug is using [Composer](http://getcomposer.org) by adding the following to your project's `composer.json`:
The recommended method of installing phpSmug is using [Composer](http://getcomposer.org). If you have Composer installed, you can install phpSmug and all its dependencies from within your project directory:

```bash
$ composer require lildude/phpsmug
```

Alternatively, you can add the following to your project's `composer.json`:

```json
{
"require": {
"guzzlehttp/oauth-subscriber": "0.3.*"
"lildude/phpsmug": "^4.0"
}
}
```

.. and then run `composer update` from within your project directory.

If you don't have Composer installed, you can download it using:

```bash
$ curl -s http://getcomposer.org/installer | php
```

... and then use it to install phpSmug and all dependencies using:

```bash
$ php composer.phar install
```

If you have Composer installed, you can install phpSmug by running the following from within your project directory:

```bash
$ composer install
```