signaller/README.md

57 lines
1.7 KiB
Markdown
Raw Normal View History

2019-08-07 14:41:21 +00:00
# ![logo](https://github.com/signaller-matrix/signaller/raw/master/logo/logo32.png) Signaller
2019-07-22 14:11:50 +00:00
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
2019-08-03 14:23:30 +00:00
[![Build Status](https://travis-ci.com/signaller-matrix/signaller.svg?branch=master)](https://travis-ci.com/signaller-matrix/signaller)
[![Coverage Status](https://coveralls.io/repos/github/signaller-matrix/signaller/badge.svg)](https://coveralls.io/github/signaller-matrix/signaller)
2019-07-22 14:11:50 +00:00
> 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
```
2019-08-03 14:23:30 +00:00
$ git clone https://github.com/signaller-matrix/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
2019-07-22 14:11:50 +00:00
2019-08-07 14:41:21 +00:00
MIT © 2019 nxshock