From 550e76ae4f911efb56cc49da62b2729abe4d0b6d Mon Sep 17 00:00:00 2001 From: Geno Date: Wed, 14 Jun 2017 14:05:20 +0200 Subject: [PATCH] [DOC] update README --- README.md | 36 +++++++++++++++++++++++------------- 1 file changed, 23 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 8f8898b..6961e6f 100644 --- a/README.md +++ b/README.md @@ -10,29 +10,39 @@ Yet another node info collector [![Build Status](https://travis-ci.org/FreifunkBremen/yanic.svg?branch=master)](https://travis-ci.org/FreifunkBremen/yanic) [![Coverage Status](https://coveralls.io/repos/github/FreifunkBremen/yanic/badge.svg?branch=master)](https://coveralls.io/github/FreifunkBremen/yanic?branch=master) +[![Go Report Card](https://goreportcard.com/badge/github.com/FreifunkBremen/yanic)](https://goreportcard.com/report/github.com/FreifunkBremen/yanic) `yanic` is a respondd client that fetches, stores and publishes information about a Freifunk network. The goals: * Generating JSON for [Meshviewer](https://github.com/ffrgb/meshviewer) -* Storing statistics in [InfluxDB](https://influxdata.com/) to be analyzed by [Grafana](http://grafana.org/) +* Storing statistics in [InfluxDB](https://influxdata.com/) or [Graphite](https://graphiteapp.org/) to be analyzed by [Grafana](http://grafana.org/) * Provide a little webserver for a standalone installation with a meshviewer -## Usage -``` -Usage of ./yanic: - -config path/to/config.toml -``` -## Configuration -Read comments in [config_example.toml](config_example.toml) for more information. - -## Live -* [meshviewer](https://map.bremen.freifunk.net) **Freifunk Bremen** with a patch to show state-version of `nodes.json` -* [grafana](https://grafana.bremen.freifunk.net) **Freifunk Bremen** show data of InfluxDB - ## How it works In the first step Yanic sends a multicast message to the group `ff02:0:0:0:0:0:2:1001` and port `1001`. Recently seen nodes that does not reply are requested via a unicast message. +## [Documentation](https://www.gitbook.com/book/freifunkbremen/yanic/details) +* [Webview](https://freifunkbremen.gitbooks.io/yanic/content/) +* [PDF](https://www.gitbook.com/download/pdf/book/freifunkbremen/yanic) +* [Mobi](https://www.gitbook.com/download/mobi/book/freifunkbremen/yanic) +* [ePUB](https://www.gitbook.com/download/epub/book/freifunkbremen/yanic) + + +## Quick startup + +### Usage +``` +Usage of ./yanic: + -config path/to/config.toml +``` +### Configuration +Read comments in [config_example.toml](config_example.toml) for more information. + +### Live +* [meshviewer](https://map.bremen.freifunk.net) **Freifunk Bremen** with a patch to show state-version of `nodes.json` +* [grafana](https://grafana.bremen.freifunk.net) **Freifunk Bremen** show data of InfluxDB + ## Related projects Collecting data from respondd: