From 6dc4666ef249a37257e329d4ea54ef6879e783bd Mon Sep 17 00:00:00 2001 From: Geno Date: Wed, 17 Feb 2021 23:25:56 +0100 Subject: [PATCH] docs: fix branch rename from master to main - Black Lives Matter --- README.md | 10 +++++----- docs/dev_database.md | 6 +++--- docs/dev_output.md | 4 ++-- docs/docs_configuration.md | 2 +- docs/index.md | 6 +++--- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1d4c8a5..29915ea 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ __ __ _ Yet another node info collector ``` -[![CircleCI](https://circleci.com/gh/FreifunkBremen/yanic/tree/master.svg?style=shield)](https://circleci.com/gh/FreifunkBremen/yanic/tree/master) -[![Coverage Status](https://coveralls.io/repos/github/FreifunkBremen/yanic/badge.svg?branch=master)](https://coveralls.io/github/FreifunkBremen/yanic?branch=master) -[![codecov](https://codecov.io/gh/FreifunkBremen/yanic/branch/master/graph/badge.svg)](https://codecov.io/gh/FreifunkBremen/yanic) +[![CircleCI](https://circleci.com/gh/FreifunkBremen/yanic/tree/main.svg?style=shield)](https://circleci.com/gh/FreifunkBremen/yanic/tree/main) +[![Coverage Status](https://coveralls.io/repos/github/FreifunkBremen/yanic/badge.svg?branch=main)](https://coveralls.io/github/FreifunkBremen/yanic?branch=main) +[![codecov](https://codecov.io/gh/FreifunkBremen/yanic/branch/main/graph/badge.svg)](https://codecov.io/gh/FreifunkBremen/yanic) [![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: @@ -23,7 +23,7 @@ In the first step Yanic sends a multicast message to the group `ff05::2:1001` an Recently seen nodes that does not reply are requested via a unicast message. ## Documentation -Take a look at the [git](https://github.com/FreifunkBremen/yanic/blob/master/SUMMARY.md) or [Gitbook](https://freifunkbremen.gitbooks.io/yanic/content/) +Take a look at the [git](https://github.com/FreifunkBremen/yanic/blob/main/SUMMARY.md) or [Gitbook](https://freifunkbremen.gitbooks.io/yanic/content/) # Installation Take a look into the Documentation (see above) or for Quick Overview in [INSTALL.md](INSTALL.md). @@ -115,7 +115,7 @@ Global Flags: ## Communities using Yanic -* **Freifunk Bremen** uses InfluxDB, [Grafana](https://grafana.bremen.freifunk.net), and [Meshviewer](https://map.bremen.freifunk.net) with a patch to show state-version of `nodes.json`. +* **Freifunk Bremen** uses InfluxDB, [Grafana](https://grafana.bremen.freifunk.net), and [Meshviewer](https://map.bremen.freifunk.net) with a patch to show state-version of `nodes.json`. * **Freifunk Nord** uses [hopglass](https://github.com/hopglass/hopglass) (commit 587740a) as frontend: https://mesh.freifunknord.de/ * **Freifunk Kiel** uses [Meshviewer](https://github.com/ffrgb/meshviewer/) as frontend: https://map.freifunk.in-kiel.de/ diff --git a/docs/dev_database.md b/docs/dev_database.md index 113b5c0..65404d2 100644 --- a/docs/dev_database.md +++ b/docs/dev_database.md @@ -1,6 +1,6 @@ # Add new database type -Write a new package to implement the interface [database.Connection:](https://github.com/FreifunkBremen/yanic/blob/master/database/database.go) +Write a new package to implement the interface [database.Connection:](https://github.com/FreifunkBremen/yanic/blob/main/database/database.go) ```go type Connection interface { @@ -42,8 +42,8 @@ Short: the function signature of _ConnectFunction_ should be `func Connect(confi -At last add you import string to compile the your database as well in this [all](https://github.com/FreifunkBremen/yanic/blob/master/database/all/main.go) package. +At last add you import string to compile the your database as well in this [all](https://github.com/FreifunkBremen/yanic/blob/main/database/all/main.go) package. -TIP: take a look in the easy database type [logging](https://github.com/FreifunkBremen/yanic/blob/master/database/logging/file.go). +TIP: take a look in the easy database type [logging](https://github.com/FreifunkBremen/yanic/blob/main/database/logging/file.go). diff --git a/docs/dev_output.md b/docs/dev_output.md index 439b3c8..48be537 100644 --- a/docs/dev_output.md +++ b/docs/dev_output.md @@ -1,6 +1,6 @@ # Add new output type -Write a new package to implement the interface [output.Output:](https://github.com/FreifunkBremen/yanic/blob/master/output/output.go) +Write a new package to implement the interface [output.Output:](https://github.com/FreifunkBremen/yanic/blob/main/output/output.go) ```go type Output interface { @@ -27,4 +27,4 @@ Short: the function signature of _Register_ should be `func Register(configurati -At last add you import string to compile the your database as well in this [all](https://github.com/FreifunkBremen/yanic/blob/master/output/all/main.go) package. +At last add you import string to compile the your database as well in this [all](https://github.com/FreifunkBremen/yanic/blob/main/output/all/main.go) package. diff --git a/docs/docs_configuration.md b/docs/docs_configuration.md index f72fbcd..2703449 100644 --- a/docs/docs_configuration.md +++ b/docs/docs_configuration.md @@ -1,6 +1,6 @@ # Configuration -Here you would find a long description, maybe the description in [example file](https://github.com/FreifunkBremen/yanic/blob/master/config_example.toml) are enough for you. +Here you would find a long description, maybe the description in [example file](https://github.com/FreifunkBremen/yanic/blob/main/config_example.toml) are enough for you. The config file for Yanic written in "Tom's Obvious, Minimal Language." [syntax](https://github.com/toml-lang/toml). (if you need somethink multiple times, checkout out the [[array of table]] section) diff --git a/docs/index.md b/docs/index.md index 92e3cb3..58cada8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,9 +10,9 @@ (previously [respond-collector](https://github.com/FreifunkBremen/respond-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) -[![codecov](https://codecov.io/gh/FreifunkBremen/yanic/branch/master/graph/badge.svg)](https://codecov.io/gh/FreifunkBremen/yanic) +[![Build Status](https://travis-ci.org/FreifunkBremen/yanic.svg?branch=main)](https://travis-ci.org/FreifunkBremen/yanic) +[![Coverage Status](https://coveralls.io/repos/github/FreifunkBremen/yanic/badge.svg?branch=main)](https://coveralls.io/github/FreifunkBremen/yanic?branch=main) +[![codecov](https://codecov.io/gh/FreifunkBremen/yanic/branch/main/graph/badge.svg)](https://codecov.io/gh/FreifunkBremen/yanic) [![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.