telephant/README.md

Telephant!
==========

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

![telephant Screenshot](/assets/screenshot.png)

## Features

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

## Installation

Make sure you have a working Go environment (Go 1.8 or higher is required).
See the [install instructions](http://golang.org/doc/install.html).

### Dependencies

Before you can build Telephant you need to install the [Go/Qt bindings](https://github.com/therecipe/qt/wiki/Installation#regular-installation).

    go get -u -v github.com/therecipe/qt/cmd/...

### Building Telephant

    $(go env GOPATH)/bin/qtdeploy build desktop github.com/muesli/telephant

### Run it

    $(go env GOPATH)/src/github.com/muesli/telephant/deploy/linux/telephant

## Development

[![GoDoc](https://godoc.org/github.com/golang/gddo?status.svg)](https://godoc.org/github.com/muesli/telephant)
[![Build Status](https://travis-ci.org/muesli/telephant.svg?branch=master)](https://travis-ci.org/muesli/telephant)
[![Go ReportCard](http://goreportcard.com/badge/muesli/telephant)](http://goreportcard.com/report/muesli/telephant)
Renamed app to Telephant 2019-05-09 14:33:26 +00:00			`Telephant!`
Updated build instructions in README 2019-05-10 15:23:22 +00:00			`==========`
Added build instructions to README 2017-08-29 05:23:35 +00:00
Added WIP Mastodon account 2019-05-01 15:15:56 +00:00			`A lightweight but modern Social Media client, written in Go & QML.`
Added build instructions to README 2017-08-29 05:23:35 +00:00
Renamed app to Telephant 2019-05-09 14:33:26 +00:00			`![telephant Screenshot](/assets/screenshot.png)`
Added screenshot to README 2017-08-29 09:55:57 +00:00
Added feature list to README 2017-08-29 05:40:25 +00:00			`## Features`

Added WIP Mastodon account 2019-05-01 15:15:56 +00:00			`- [x] Live feed via Mastodon's Streaming API`
Added feature list to README 2017-08-29 05:40:25 +00:00			`- [x] Multi pane support`
Updated README regarding platform support 2017-08-29 11:14:53 +00:00			`- [x] Linux/macOS/Windows (Android & iOS should be working, but aren't tested yet)`
Tick 'Media previews' in features section of README 2017-08-30 23:32:06 +00:00			`- [x] Media previews`
Tick shortened URL support in README 2017-08-31 21:53:44 +00:00			`- [x] Shortened URL resolving`
Added badges to README 2017-08-29 05:56:24 +00:00			`- [ ] System notifications`
Added WIP Mastodon account 2019-05-01 15:15:56 +00:00			`- [ ] Multiple accounts (work-in-progress)`
			`- [ ] Support for more networks`
Added feature list to README 2017-08-29 05:40:25 +00:00
Added build instructions to README 2017-08-29 05:23:35 +00:00			`## Installation`

Updated README 2018-01-22 06:12:15 +00:00			`Make sure you have a working Go environment (Go 1.8 or higher is required).`
			`See the [install instructions](http://golang.org/doc/install.html).`
Added build instructions to README 2017-08-29 05:23:35 +00:00
			`### Dependencies`

Renamed app to Telephant 2019-05-09 14:33:26 +00:00			`Before you can build Telephant you need to install the [Go/Qt bindings](https://github.com/therecipe/qt/wiki/Installation#regular-installation).`
Added build instructions to README 2017-08-29 05:23:35 +00:00
Updated build instructions in README 2019-05-10 15:23:22 +00:00			`go get -u -v github.com/therecipe/qt/cmd/...`
Added build instructions to README 2017-08-29 05:23:35 +00:00
Updated build instructions in README 2019-05-10 15:23:22 +00:00			`### Building Telephant`
Added build instructions to README 2017-08-29 05:23:35 +00:00
Updated build instructions in README 2019-05-10 15:23:22 +00:00			`$(go env GOPATH)/bin/qtdeploy build desktop github.com/muesli/telephant`
Added build instructions to README 2017-08-29 05:23:35 +00:00
Updated build instructions in README 2019-05-10 15:23:22 +00:00			`### Run it`
Added build instructions to README 2017-08-29 05:23:35 +00:00
Updated build instructions in README 2019-05-10 15:23:22 +00:00			`$(go env GOPATH)/src/github.com/muesli/telephant/deploy/linux/telephant`
Move logo to the bottom of the README 2017-08-29 14:08:44 +00:00
Added build instructions to README 2017-08-29 05:23:35 +00:00			`## Development`

Renamed app to Telephant 2019-05-09 14:33:26 +00:00			`[![GoDoc](https://godoc.org/github.com/golang/gddo?status.svg)](https://godoc.org/github.com/muesli/telephant)`
			`[![Build Status](https://travis-ci.org/muesli/telephant.svg?branch=master)](https://travis-ci.org/muesli/telephant)`
			`[![Go ReportCard](http://goreportcard.com/badge/muesli/telephant)](http://goreportcard.com/report/muesli/telephant)`