Skip to content

Commit

Permalink
docs: Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AungMyoKyaw committed Dec 30, 2017
1 parent c852833 commit 999ad9c
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 1 deletion.
44 changes: 43 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,45 @@
# ZuZu Electron
> Zawgyi <=> Unicode Converter that lives in your menu bar.
## Web Version
<img src="./assets/zuzu.gif" alt="zuzu" align="right">

## Install
- [mac](https://github.com/AungMyoKyaw/zuzu-menubar-app/releases/latest)
- [window](https://github.com/AungMyoKyaw/zuzu-menubar-app/releases/latest)

## User Guide
### Toggle ZUZU
- <kbd>command</kbd>+<kbd>shift</kbd>+<kbd>space</kbd> [mac]
- <kbd>control</kbd>+<kbd>shift</kbd>+<kbd>space</kbd> [window]

### Convert
- <kbd>command</kbd>+<kbd>enter</kbd> [mac]
- <kbd>control</kbd>+<kbd>enter</kbd> [window]

### Open Preference
- <kbd>command</kbd>+<kbd>,</kbd> [mac]
- <kbd>control</kbd>+<kbd>,</kbd> [window]

### Close App
- <kbd>command</kbd>+<kbd>q</kbd> [mac]
- <kbd>alt</kbd>+<kbd>f4</kbd> [window]

## Development
```shell
npm install
npm start
```

## Build
```shell
npm run build
```

## Built with
- Electron
- React
- Redux
- React Router

## License
[MIT](./LICENSE)
Binary file added assets/zuzu.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 999ad9c

Please sign in to comment.