Skip to content

Commit

Permalink
📝 Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
patrick-fu committed Jun 22, 2022
1 parent 70ac0eb commit 390c180
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
Binary file added .github/assets/app_macos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/assets/app_windows.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

A Gitmoji app for macOS, Linux, and Windows.

<img src=.github/assets/app_macos.png width=30%>
<img src=.github/assets/app_windows.png width=30%>

## What is this

GitmojiApp is a simple desktop app that allows you to add a [Gitmoji](https://gitmoji.dev) to your git commit messages.
Expand All @@ -12,7 +15,9 @@ GitmojiApp is a simple desktop app that allows you to add a [Gitmoji](https://gi

Download the latest prebuilt binary from [Github release](https://github.com/patrick-fu/GitmojiApp/releases)

> Note that the macOS App is not notarized by Apple, so you should codesign it by yourself, otherwise you can not open it.
> Note that the macOS App is not notarized by Apple, so you should right click the "GitmojiApp.app" and select "Open" for the first time, then move it to your `/Applications` folder.
Or you can codesign it by yourself to make it a trusted app.

```bash
# Unzip the artifact and cd into the folder
Expand All @@ -34,3 +39,9 @@ $ flutter build linux
# On Windows
$ flutter build windows
```

## Todo

- [ ] Tray mode
- [ ] Font embedded
- [ ] Select emoji style (Apple / Google / Twitter / etc.)

0 comments on commit 390c180

Please sign in to comment.