Skip to content

Commit

Permalink
Clarify installation updates
Browse files Browse the repository at this point in the history
* Add: Version 0.1
* Fix: Installation/update processes
* Fix: Typos
  • Loading branch information
bheisig committed Feb 9, 2017
1 parent 6f53ea5 commit cab9e9c
Showing 1 changed file with 28 additions and 25 deletions.
53 changes: 28 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,53 +34,52 @@ Why should you use this client? There are some good reasons:

You have several options to download (and kinda install) the API client:

* Install any version via [Composer](https://getcomposer.org/)
* Install any version via [Composer](https://getcomposer.org/) (**recommended**)
* Download any stable release manually
* Clone the Git repository to fetch the (unstable) development branch
* Clone the Git repository to fetch the (maybe unstable) development branch


### Using Composer

Change to your project's root directory and type the following command:

#### Locally
~~~ {.bash}
composer require "bheisig/idoitapi=>=0.1"
~~~

For a system-wide installation add `global` as an option:

~~~ {.bash}
composer global require "bheisig/idoitapi=>=0.1"
~~~

Add a new dependency on `bheisig/idoitapi` to your project's `composer.json` file. Here is a minimal example to install the current development branch locally:
As an alternative add a new dependency on `bheisig/idoitapi` to your project's `composer.json` file. Here is a minimal example to install the current development branch locally:

~~~ {.json}
{
"require": {
"bheisig/idoitapi": "@DEV"
"bheisig/idoitapi": ">=0.1"
}
}
~~~

After that you need to call composer to install the API client (under `vendor/bheisig/idoitapi` by default):
After that you need to call composer to install the API client (under `vendor/bheisig/idoitapi/` by default):

~~~ {.bash}
composer install
~~~

As an alternative to the steps mentioned above just run:
This installs version `0.1` or higher if available. Instead of sticking to a specific/minimum version you may switch to the current development branch by using `@DEV`:

~~~ {.bash}
composer require "bheisig/idoitapi=@DEV"
composer install
~~~


#### System-wide

For a system-wide installation you may use:

~~~ {.bash}
composer global require "bheisig/idoitapi=@DEV"
~~~

Make sure you have `~/.composer/vendor/bin/` in your path.


#### Updates

Composer has the great advantage (besides many other) that you can simply update the API client by running this command:
Composer has the great advantage (besides many others) that you can simply update the API client by running:

~~~ {.bash}
composer update
Expand All @@ -89,26 +88,30 @@ composer update

### Download Release

You will find [all releases on this site](https://github.com/bheisig/i-doit-api-client-php/releases).

To fetch the latest stable release:
You find [all releases on the project site](https://github.com/bheisig/i-doit-api-client-php/releases). Fetch the latest stable release:

~~~ {.bash}
wget FIXME // No releases at the moment ;-)
tar xvzf FIXME
wget https://github.com/bheisig/i-doit-api-client-php/releases/download/0.1/i-doit-api-client-php-0.1.tar.gz
tar xvzf i-doit-api-client-php-0.1.tar.gz
cd i-doit-api-client-php/
~~~


### Fetch Source Code

Fetch the current (unstable) development branch:
Fetch the current (maybe unstable) development branch:

~~~ {.bash}
git clone https://github.com/bheisig/i-doit-api-client-php.git
cd i-doit-api-client-php/
~~~

To fetch updates run:

~~~ {.bash}
git pull
~~~


## Usage

Expand Down

0 comments on commit cab9e9c

Please sign in to comment.