signaller/README.md

# Signaller

[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
[![Build Status](https://travis-ci.com/nxshock/signaller.svg?branch=master)](https://travis-ci.com/nxshock/signaller)
[![Coverage Status](https://coveralls.io/repos/github/nxshock/signaller/badge.svg)](https://coveralls.io/github/nxshock/signaller)

> A Matrix homeserver, which written in Go language.

This is a lightweight (but full-featured) Matrix server, written in Go language, which has ease of deployment. The implementation is aimed specifically to HOMEservers (which are usually small, for example, Raspberry Pi).

## Table of Contents

- [Signaller](#Signaller)
  - [Table of Contents](#Table-of-Contents)
  - [Building](#Building)
  - [Usage](#Usage)
  - [Project status](#Project-status)
  - [Maintainers](#Maintainers)
  - [Contributing](#Contributing)
  - [License](#License)

## Building

```
$ git clone https://github.com/nxshock/signaller.git
$ cd signaller
$ make
```

## Usage

```bash
# TODO
./signaller
```

## Project status

Currect implemented Matrix APIs (version of specs: r0.5.0): see [STATUS](STATUS.md) document.

## Maintainers

[@nxshock](https://github.com/nxshock)
[@ChronosX88](https://github.com/ChronosX88)

## Contributing

See [the contributing file](CONTRIBUTING.md)!

PRs accepted.

Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.

## License

MIT © 2019 nxshock