Skip to content

Commit

Permalink
Updated readme, bumped to 1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
peterjaap committed Sep 7, 2022
1 parent b707efd commit 236f9b4
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,29 @@ When you open up a project directory, the GUI will create 2 result files in the

## Screenshots

![image](https://user-images.githubusercontent.com/431360/146057836-512a0714-52ca-42a5-8d60-00e0d5cf77f7.png)

![image](https://user-images.githubusercontent.com/431360/146058024-123910fa-26b5-4f96-b0cb-b8f582a67594.png)
![image](https://user-images.githubusercontent.com/431360/188888785-e4add7f7-6331-489a-acb7-83620484b8a1.png)

![image](https://user-images.githubusercontent.com/431360/188888901-280173d2-b074-46d6-a77b-7c50114662ef.png)

## Installation

Download the `AppImage` file from the [releases](https://github.com/elgentos/magento2-upgrade-gui/releases) page. Make it executable (with `chmod +x`) and run it!

## GitLab integration

By setting a few .env variables, you can auto-update an issue with your progress. The GUI will create a note on the issue with a Markdown table. It will then update that note when an item is changed.

`.env`

```
GITLAB_HOST=https://gitlab.com
GITLAB_TOKEN=abcdefghijklmnopqrstuvwxyz
GITLAB_PROJECT_ID=123
GITLAB_ISSUE_ID=123
```

![image](https://user-images.githubusercontent.com/431360/188888302-46c79be9-d499-4dcf-b71a-7359d09bdcf3.png)

## Development

Clone this repo and run this command to install all necessary dependencies:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "magento2-upgrade-gui",
"version": "1.0.0",
"version": "1.1.0",
"description": "A GUI tool to help you visually and easily spot differences in a three-way comparison between the version you upgraded from, the version you upgraded to, and your Magento preferences, plugins and overrides.",
"author": "Peter Jaap Blaakmeer / elgentos",
"license": "MIT",
Expand Down

0 comments on commit 236f9b4

Please sign in to comment.