Whalebird-desktop-client-ma.../README.md

59 lines
1.3 KiB
Markdown
Raw Normal View History

2018-03-07 14:28:48 +01:00
# whalebird
2018-03-22 17:06:49 +01:00
Whalebird is a mastodon client for desktop application. If you want to use release build, please download from [release page](https://github.com/h3poteto/whalebird-desktop/releases).
2018-03-07 14:28:48 +01:00
2018-03-23 16:05:24 +01:00
![demo](screenshot.png)
2018-03-22 17:06:49 +01:00
## Feature
- Slack like interface
- Notify to desktop
- Streaming
- Many keyboard shortcuts
- Manage multiple accounts
## Install
### Mac
Download from [release page](https://github.com/h3poteto/whalebird-desktop/releases), and to decompress. I recommend that you move `whalebird.app` to `/Applications`.
Please wait for distribute in Mac app store, I'm preparing.
### Linux
Download from [release page](https://github.com/h3poteto/whalebird-desktop/releases), and to decompress. I'm preparing deb and rmp packages.
### Windows
TODO.
Please wait...
## Development
2018-03-07 14:28:48 +01:00
``` bash
2018-03-22 17:06:49 +01:00
# clone this repository
$ git clone https://github.com/h3poteto/whalebird-desktop.git
$ cd whalebird-desktop
2018-03-07 14:28:48 +01:00
# install dependencies
2018-03-22 17:06:49 +01:00
$ npm install
2018-03-07 14:28:48 +01:00
# serve with hot reload at localhost:9080
2018-03-22 17:06:49 +01:00
$ npm run dev
```
2018-03-07 14:28:48 +01:00
2018-03-22 17:06:49 +01:00
## Release
2018-03-07 14:28:48 +01:00
2018-03-22 17:06:49 +01:00
I prepared Makefile for production release.
2018-03-07 14:28:48 +01:00
2018-03-22 17:06:49 +01:00
```bash
# for linux
$ make VERSION=0.1.0 PLATFORM=linux
2018-03-07 14:28:48 +01:00
2018-03-22 17:06:49 +01:00
# for mac
$ make VERSION=0.1.0 PLATFORM=darwin CERTNAME="Develper ID Application: NAME (ID)"
2018-03-07 14:28:48 +01:00
```
2018-03-22 17:06:49 +01:00
# License
The software is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).