telephant/README.md
Christian Muehlhaeuser 9aa49a24af
Added feature to README
2017-08-29 15:04:13 +02:00

1.4 KiB

Chirp!

A lightweight but modern Twitter client, written in Go & QML.

chirp Screenshot

Features

  • Live feed via Twitter's Streaming API
  • Multi pane support
  • Linux/macOS/Windows (Android & iOS should be working, but aren't tested yet)
  • Multiple Twitter accounts (work-in-progress)
  • Media previews
  • System notifications
  • Shortened URL resolving

Installation

Make sure you have a working Go environment. See the install instructions.

Dependencies

Before you can build Chirp you need to install the Go/Qt bindings.

Building Chirp!

git clone https://github.com/muesli/chirp.git
qtdeploy build desktop chirp/

Run it

./chirp/deploy/linux/chirp

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/. 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.

Development

API docs can be found here.

Build Status Go ReportCard