Skip to content

Commit 76c30e5

Browse files
committed
Updated readme for composer
1 parent af8db4f commit 76c30e5

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,24 @@
33
This tool uses the [Redmine REST API](http://www.redmine.org/projects/redmine/wiki/Rest_api)
44
for fetching data from a specific project and push that to a git repository.
55

6+
Currently only wiki pages are supported.
7+
68
## Installation
79

8-
* Install [composer](https://getcomposer.org/)
9-
* Run `composer install` in this directory
10+
The installation is simple by using [composer](https://getcomposer.org/). After [installing composer](https://getcomposer.org/doc/00-intro.md) you can either install the command globally or within a project.
11+
12+
### Global
13+
14+
In the global installation `redmine-to-git` will be available as a command line tool.
15+
16+
* Run `composer global require derhasi/redmine-to-git` to install globally.
17+
* Add `export PATH=~/.composer/vendor/bin:$PATH` to your `.bashrc`or `.profile`
18+
19+
After the installation you should be able to run `redmine-to-git wiki ...` from anywhere.
20+
21+
### Local
22+
23+
You can run `composer require derhasi/redmine-to-git` in any composer enabled project to add this project as a dependency.
1024

1125
## Usage
1226

0 commit comments

Comments
 (0)