telephant/README.md

50 lines
1.6 KiB
Markdown
Raw Normal View History

2017-08-29 05:23:35 +00:00
Chirp!
======
2017-08-29 05:09:55 +00:00
A lightweight but modern Twitter client, written in Go & QML.
2017-08-29 05:23:35 +00:00
2017-08-29 14:05:23 +00:00
![chirp Screenshot](/assets/screenshot.png)
2017-08-29 09:55:57 +00:00
2017-08-29 05:40:25 +00:00
## Features
- [x] Live feed via Twitter's Streaming API
- [x] Multi pane support
- [x] Linux/macOS/Windows (Android & iOS should be working, but aren't tested yet)
2017-08-29 05:40:25 +00:00
- [ ] Multiple Twitter accounts (work-in-progress)
- [ ] Media previews
2017-08-29 05:56:24 +00:00
- [ ] System notifications
2017-08-29 13:04:13 +00:00
- [ ] Shortened URL resolving
- [ ] Support for other networks (like Mastodon/GNU social or even GitHub)
2017-08-29 05:40:25 +00:00
2017-08-29 14:05:23 +00:00
![chirp logo](/assets/chirp.png)
2017-08-29 05:23:35 +00:00
## Installation
Make sure you have a working Go environment. See the [install instructions](http://golang.org/doc/install.html).
### Dependencies
Before you can build Chirp you need to install the [Go/Qt bindings](https://github.com/therecipe/qt/wiki/Installation#regular-installation).
### Building Chirp!
git clone https://github.com/muesli/chirp.git
qtdeploy build desktop chirp/
### Run it
./chirp/deploy/linux/chirp
2017-08-29 11:37:46 +00:00
### Config
As of now you will need to create your own Twitter app & key to use Chirp. You can do this on [https://dev.twitter.com/](https://dev.twitter.com/).
When you run Chirp for the first time, it will create an empty config file `chirp.conf` for you. Just edit it and enter
your consumer key and accesstoken.
2017-08-29 05:23:35 +00:00
## Development
API docs can be found [here](http://godoc.org/github.com/muesli/chirp).
2017-08-29 05:56:24 +00:00
2017-08-29 10:57:18 +00:00
[![Build Status](https://travis-ci.org/muesli/chirp.svg?branch=master)](https://travis-ci.org/muesli/chirp)
2017-08-29 05:56:24 +00:00
[![Go ReportCard](http://goreportcard.com/badge/muesli/chirp)](http://goreportcard.com/report/muesli/chirp)