Skip to content

Commit f2a9d57

Browse files
committed
Update readme, set version
1 parent 15caf41 commit f2a9d57

File tree

2 files changed

+28
-3
lines changed

2 files changed

+28
-3
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,34 @@ The goal of Gitify is to provide a **two-way sync** of data typically stored in
55

66
The project configuration, which determines what data is written to file and build to the database, is stored in a `.gitify` file in the project root.
77

8-
## Quick Installation
8+
## Upgrading to v2 (:warn: in development)
99

10-
```` shell
10+
Gitify v2 brings updated dependencies, additional functionality, and easier installation/updates via Composer.
11+
12+
The data file structure is unchanged, so you can safely update to v2.
13+
14+
1. To upgrade **with the intention of contributing to Gitify**, you can keep your installation. Bring it up to date with the master branch (`git fetch origin && git reset --hard origin/master`, or `git fetch upstream && git reset --hard upstream/master`), install the updated dependencies (`composer install`), and you're ready to go. You'll need to repeat these steps to upgrade to newer versions.
15+
2. To upgrade **simply to use Gitify**, it's recommended to remove the v1 git-based installation complete, and instead install Gitify globally with Composer as described in the installation below.
16+
17+
**Important to know:**
18+
19+
- Gitify v2 is not yet compatible with Gitify Watch. This will be restored in a future update of Gitify Watch.
20+
- The minimum PHP version has been increased to 7.2.5.
21+
- Documentation has not yet been updated for v2. This will happen soon.
22+
23+
## Installation
24+
25+
````bash
26+
composer global require modmore/gitify
27+
````
28+
29+
If that does not make gitify available on your path, add the output of `composer global config bin-dir --absolute` to your path (i.e. in the `~/.bash_profile` or `~/.zshrc` file on Mac/Linux).
30+
31+
To update, use `composer global update modmore/gitify`.
32+
33+
### Manual Installation
34+
35+
````bash
1136
$ git clone https://github.com/modmore/Gitify.git Gitify
1237
$ cd Gitify
1338
$ composer install --no-dev

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.1.2-pl
1+
2.0.0-alpha1

0 commit comments

Comments
 (0)