From c172c8e6296377ba4b3ae2aef393893d205d76d7 Mon Sep 17 00:00:00 2001 From: Harald Eilertsen Date: Sat, 9 Apr 2022 11:11:35 +0200 Subject: Add some info about usage etc to head of file. --- hubzilla-versions.rb | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/hubzilla-versions.rb b/hubzilla-versions.rb index e1977e7..203aa57 100755 --- a/hubzilla-versions.rb +++ b/hubzilla-versions.rb @@ -1,8 +1,36 @@ #!/usr/bin/env ruby # SPDX-FileCopyrightText: 2022 Harald Eilertsen -# # SPDX-License-Identifier: AGPL-3.0-or-later +# +# A small program to query the-federation.info about the known Hubzilla +# instances and output a simple overview of which versions are actively in use. +# +# Usage: +# +# ./hubzilla-versions.rb [] +# +# With no arguments it fetches the information directly from +# the-federation.info. +# +# If you already have a downloaded json file with the proper fields available, +# you can supply the file name as the only argument, and it will use that +# instead of fetching it from the remote server. Mostly useful during +# development/testing to not overload the remote server. +# +# Requirements: +# +# - A standard installation of the Ruby programming language. +# (tested on Ruby version 3.0.3, but should afaict work on any +# recent ruby.) +# +# License: +# +# This program is licensed under the GNU Affero General Public License version +# 3.0 (or at your option a later version), which means you are free to use, +# study, share and improve the program as you will. See +# LICENSES/AGPL-3.0-or-later.txt for the details. +# require 'erb' require 'json' -- cgit v1.2.3