docs: fix branch rename from master to main - Black Lives Matter
This commit is contained in:
parent
aff906d734
commit
6dc4666ef2
10
README.md
10
README.md
|
|
@ -8,9 +8,9 @@ __ __ _
|
|||
Yet another node info collector
|
||||
```
|
||||
|
||||
[](https://circleci.com/gh/FreifunkBremen/yanic/tree/master)
|
||||
[](https://coveralls.io/github/FreifunkBremen/yanic?branch=master)
|
||||
[](https://codecov.io/gh/FreifunkBremen/yanic)
|
||||
[](https://circleci.com/gh/FreifunkBremen/yanic/tree/main)
|
||||
[](https://coveralls.io/github/FreifunkBremen/yanic?branch=main)
|
||||
[](https://codecov.io/gh/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/
|
||||
|
||||
|
|
|
|||
|
|
@ -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).
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -10,9 +10,9 @@
|
|||
|
||||
(previously [respond-collector](https://github.com/FreifunkBremen/respond-collector))
|
||||
|
||||
[](https://travis-ci.org/FreifunkBremen/yanic)
|
||||
[](https://coveralls.io/github/FreifunkBremen/yanic?branch=master)
|
||||
[](https://codecov.io/gh/FreifunkBremen/yanic)
|
||||
[](https://travis-ci.org/FreifunkBremen/yanic)
|
||||
[](https://coveralls.io/github/FreifunkBremen/yanic?branch=main)
|
||||
[](https://codecov.io/gh/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.
|
||||
|
|
|
|||
Loading…
Reference in New Issue