docs: refactor README.md and replace SportsBanger links with local links

.github/workflows/check_main_databases.yml

@@ -1,6 +1,6 @@
 name: Check main databases CSV format
 
-on: 
+on:
   pull_request:
     paths:
       - "plane-alert-db.csv"

README.md

@@ -1,69 +1,85 @@
-# plane-alert-db
+# plane-alert-db <!-- omit in toc -->
 
-This project consists of lists of 'interesting' aircraft, formatted as CSV files. The list is designed to work with the excellent **https://github.com/kx1t/docker-planefence** .
+This project consists of lists of 'interesting' aircraft, formatted as CSV files. The list is designed to work with the excellent **<https://github.com/kx1t/docker-planefence>**.
 
 > **Warning**
-> Please only suggest/make any changes to the [plane-alert-db.csv](plane-alert-db.csv), [plane-alert-twitter-blocked.csv](plane-alert-twitter-blocked.txt), [plane-alert-pia.csv](plane-alert-pia.csv), [plane-alert-ukraine.csv](plane-alert-ukraine.csv) and [plane_images.txt](plane_images.txt) files on GitHub - all other files (except PIA) are generated from this file, and if you do not make your changes there, they will be overwritten and lost.
+> Please only suggest/make any changes to the [plane-alert-db.csv](plane-alert-db.csv), [plane-alert-twitter-blocked.csv](plane-alert-twitter-blocked.txt), [plane-alert-pia.csv](plane-alert-pia.csv), [plane-alert-ukraine.csv](plane-alert-ukraine.csv) and [plane_images.txt](plane_images.txt) files on GitHub - all other files are generated from this file, and if you do not make your changes there, they will be overwritten and lost.
 
-# Current Content
+- [Current Content](#current-content)
+- [Description of Categories](#description-of-categories)
+- [Planefence](#planefence)
+- [Contributing](#contributing)
+  - [To do / Ideas](#to-do--ideas)
+- [Disclaimer, excuses and dodges](#disclaimer-excuses-and-dodges)
+- [Data Sources](#data-sources)
 
-The list contains **12847** unique aircraft in **49** different categories.
+## Current Content
 
-- [plane-alert-db.csv](https://github.com/Sportsbadger/plane-alert-db/blob/main/plane-alert-db.csv) - The list of interesting aircraft, with tags,categories and links. (12847)
-- [plane-alert-civ.csv](https://github.com/Sportsbadger/plane-alert-db/blob/main/plane-alert-civ.csv) - Civilian Registered Aircraft, includes Historic and Distinctive. (3310)
-- [plane-alert-mil.csv](https://github.com/Sportsbadger/plane-alert-db/blob/main/plane-alert-mil.csv) - Military Only. (7065)
-- [plane-alert-pol.csv](https://github.com/Sportsbadger/plane-alert-db/blob/main/plane-alert-pol.csv) - Police Forces. (862)
-- [plane-alert-gov.csv](https://github.com/Sportsbadger/plane-alert-db/blob/main/plane-alert-gov.csv) - Governments, Gov Agencies and Dictators. (1590)
+There currently are about **12848** unique aircraft in **49** categories found in this repository. This [Dashboard](https://datastudio.google.com/reporting/eb19ab53-b622-4946-b34a-9667232c136d/page/4taCC) contains details of the main list and the most recent additions.
+These aircraft are divided into five main databases:
 
+- [plane-alert-db.csv](plane-alert-db.csv) - A list of interesting aircraft with tags, categories and links. (12848)
+- [plane-alert-pia.csv](plane-alert-pia.csv): A list that contains PIA planes. (52)
+- [plane-alert-twitter-blocked.csv](plane-alert-twitter-blocked.csv): A list of aircraft that will cause your Twitter account to be banned when used with `docker-planefence`. **Please use it with care**. (9)
+- [plane-alert-ukraine.csv](plane-alert-ukraine.csv): A list with Ukrainian planes. (24)
+- [plane_images.txt](plane_images.txt): A accompanying list that contains aircraft images. (12881)
 
-There is also a second version of each of the above lists with up to 3 image image links per aircraft. **Please consider this experimental, do not come to rely of any of the image links**
+Based on these main databases, several derivative databases are created using a [GitHub action](https://github.com/sdr-enthusiasts/plane-alert-db/actions/workflows/create_db_derivatives.yaml):
 
-- [plane-alert-db-images.csv](https://github.com/Sportsbadger/plane-alert-db/blob/main/plane-alert-db-images.csv) - The list of interesting aircraft, with tags,categories and links. (12847)
-- [plane-alert-civ-images.csv](https://github.com/Sportsbadger/plane-alert-db/blob/main/plane-alert-civ-images.csv) - Civilian Registered Aircraft, includes Historic and Distinctive. (3310)
-- [plane-alert-mil-images.csv](https://github.com/Sportsbadger/plane-alert-db/blob/main/plane-alert-mil-images.csv) - Military Only. (7065)
-- [plane-alert-pol-images.csv](https://github.com/Sportsbadger/plane-alert-db/blob/main/plane-alert-pol-images.csv) - Police Forces. (862)
-- [plane-alert-gov-images.csv](https://github.com/Sportsbadger/plane-alert-db/blob/main/plane-alert-gov-images.csv) - Governments, Gov Agencies and Dictators. (1590)
+- [plane-alert-civ.csv](plane-alert-civ.csv) - Civilian Registered Aircraft, includes Historic and Distinctive. (3310)
+- [plane-alert-mil.csv](plane-alert-mil.csv) - Military Only. (7065)
+- [plane-alert-pol.csv](plane-alert-pol.csv) - Police Forces. (862)
+- [plane-alert-gov.csv](plane-alert-gov.csv) - Governments, Gov Agencies and Dictators. (1590)
+
+A second version of each of the above lists contains up to 4 image links per aircraft. These lists are created in [GitHub action](https://github.com/sdr-enthusiasts/plane-alert-db/actions/workflows/create_db_derivatives.yaml) using the [plane_images.txt](plane_images.txt) database. **Please consider this experimental, do not come to rely on any of the image links**
+
+- [plane-alert-db-images.csv](plane-alert-db-images.csv)
+- [plane-alert-twitter-blocked-images.csv](plane-alert-twitter-blocked.csv)
+- [plane-alert-ukraine-images.csv](plane-alert-ukraine.csv)
+- [plane-alert-civ-images.csv](plane-alert-civ-images.csv)
+- [plane-alert-mil-images.csv](plane-alert-mil-images.csv)
+- [plane-alert-pol-images.csv](plane-alert-pol-images.csv)
+- [plane-alert-gov-images.csv](plane-alert-gov-images.csv)
 
 This [Dashboard](https://datastudio.google.com/reporting/eb19ab53-b622-4946-b34a-9667232c136d/page/4taCC) contains details of the main list and the most recent additions.
 
-# Description of Categories
+## Description of Categories
 
 Think of categories like groups, with similar or related aircraft listed together. This allows you to easily select a subset of the list for your own use. The category names (and tags) come from my rather idiosyncratic sense of humour. If you have better suggestions I'm all ears.
 
-
 - Aerobatic Teams \- Red Arrows, Blue Angels etc. (65)
-- Army Air Corp \- UK Army Air Corp. Mainly Helicopters. (94)
+- Army Air Corp \- UK Army Air Corp. Mainly Helicopters (94)
 - As Seen on TV \- Companies and Brands (368)
 - Big Hello \- Large Helicopters (sic) (104)
 - Bizjets \- Fancy pants planes for fancy pants people (38)
 - Climate Crisis \- Oil Companies, Large Business Jets - BBJs and ACJs (169)
 - Coastguard \- Coastguard, Customs and Border Patrols (434)
 - Da Comrade \- Russian or Soviet Aircraft. I love their design, so they get their own category (91)
 - Dictator Alert \- People of potentially questionable morals and values (322)
-- Distinctive \- Unique and/or special aircraft e.g The AN-225 Myria, NASA aircraft, Testbeds (178)
+- Distinctive \- Unique and/or special aircraft e.g. The AN-225 Myria, NASA aircraft, Testbeds (178)
 - Dogs with Jobs \- Aircraft with specific roles and/or modifications (163)
-- Don't you know who I am ? \- Famous People. I was going to say notable, but I'll go with Famous (21)
+- Don't you know who I am? \- Famous People. I was going to say notable, but I'll go with Famous (21)
 - Flying Doctors \- Air Ambulance and Medical Flights (658)
-- Football  \- Actual, Aussie Rules or American. We don't discriminate. (2)
+- Football \- Actual, Aussie Rules or American. We don't discriminate. (2)
 - GAF \- Aircraft of the German Air Force, thank to Rhodan76 (401)
-- Gas Bags \- Would you like to ride in my beautiful balloon ? (14)
+- Gas Bags \- Would you like to ride in my beautiful balloon? (14)
 - Governments \- Aircraft registered to Governments (237)
 - Gunship \- Brrrrrrrrrrrrrrrrrrrt (256)
-- Hired Gun \- Why do the dirty work when someone else can do it for you ? (135)
-- Historic \- It's older than I am, and most likely has a prop. (355)
+- Hired Gun \- Why do the dirty work when someone else can do it for you? (135)
+- Historic \- It's older than I am and most likely has a prop. (355)
 - Jesus he Knows me \- Aircraft owned and operated by Religious organisations (20)
 - Joe Cool \- Cool Planes. Or at least I think they are cool. (197)
 - Jump Johnny Jump \- de Havilland Chipmunks. Air Cadets of a certain age will understand. (388)
-- Nuclear \- Nuclear Emergency Support Team etc (16)
+- Nuclear \- Nuclear Emergency Support Team etc. (16)
 - Oligarch \- I made this money all by myself. (41)
 - Other Air Forces \- Air Force aircraft that are not RAF or USAF (1991)
 - Other Navies \- Navy Aircraft that are not Royal Navy Fleet Air Arm or United States Navy (188)
 - Oxcart \- Intelligence gathering aircraft (687)
 - Perfectly Serviceable Aircraft \- Why do you keep jumping out of a Perfectly Serviceable Aircraft aka Skydiving planes (43)
 - PIA \- Privacy ICAO Address....you can run, but you cannot hide (16)
 - Police Forces \- Your friendly neighbourhood flying (insert local colloquialism here) (845)
-- Ptolemy would be proud \- Mapping and Aerial Survey aircraft.  (110)
-- Quango \- Nato, United Nations, World Bank etc (32)
+- Ptolemy would be proud \- Mapping and Aerial Survey aircraft. (110)
+- Quango \- Nato, United Nations, World Bank etc. (32)
 - Radiohead \- Very Very special aircraft. Think VC25. (6)
 - RAF \- Aircraft of the Royal Air Force (229)
 - Royal Aircraft \- Aircraft used or owned by the UK Royal Family (8)
@@ -77,37 +93,46 @@ Think of categories like groups, with similar or related aircraft listed togethe
 - USAF \- Aircraft of the United States Air Force (2138)
 - Vanity Plate \- Distinctive registrations (66)
 - Watch Me Fly \- Flying and Training Schools (75)
-- You came here in that thing ? \- Microlights, tiny planes and helis..think Yakima Super Breezy (thanks skstrand). (98)
+- You came here in that thing? \- Microlights, tiny planes and helis..think Yakima Super Breezy (thanks skstrand). (98)
 - Zoomies \- Fast jets, fighters. Anything that moves fast. (134)
 
-# Planefence
+## Planefence
 
-The list takes the form 
+The list takes the form:
 
-- $ICAO,$Registration,$Operator,$Type,$ICAO Type,#CMPG,$Tag 1,$#Tag 2,$#Tag 3,Category,$#Link
+| $ICAO  | $Registration | $Operator                | $Type                | $ICAO Type | #CMPG | $Tag 1           | $#Tag 2      | $#Tag 3    | Category        | $#Link                                               |
+| ------ | ------------- | ------------------------ | -------------------- | ---------- | ----- | ---------------- | ------------ | ---------- | --------------- | ---------------------------------------------------- |
+| 502C5C | YL-KSH        | Baltic Bees display team | Aero L-39C Albatross | L39        | Civ   | Do A Barrel Roll | Display Team | Aerobatics | Aerobatic Teams | <https://en.wikipedia.org/wiki/Baltic_Bees_Jet_Team> |
 
-e.g 502C5C,YL-KSH,Baltic Bees display team,Aero L-39 C,L39,Civ,Do A Barrel Roll,Display Team,,Aerobatic Teams,https://en.wikipedia.org/wiki/Baltic_Bees_Jet_Team
+To use this list with Planefence, configure your `planefence.config` setup to include the following line:
 
-To use this list with Planefence, simply configure your planefence.config setup to include the following line:
-
-- PF_ALERTLIST=https://raw.githubusercontent.com/Sportsbadger/plane-alert-db/main/plane-alert-db.csv
+```config
+PF_ALERTLIST=https://raw.githubusercontent.com/Sportsbadger/plane-alert-db/main/plane-alert-db.csv
+```
 
 If you want to add the list in addition to your local plane-alert-db.txt list, you can do the following:
 
-- PF_ALERTLIST=plane-alert-db.txt,https://raw.githubusercontent.com/Sportsbadger/plane-alert-db/main/plane-alert-gov.csv,https://raw.githubusercontent.com/Sportsbadger/plane-alert-db/main/plane-alert-pol.csv
+```config
+PF_ALERTLIST=plane-alert-db.txt,https://raw.githubusercontent.com/Sportsbadger/plane-alert-db/main/plane-alert-gov.csv,https://raw.githubusercontent.com/Sportsbadger/plane-alert-db/main/plane-alert-pol.csv
+```
 
 **Note -- the priority of use is first-to-last, so if you want your local list to be interpreted first, move it to the front of the list**
 
-Add these characters to the column headers to control the behavior of PlaneAlert
+Add these characters to the column headers to control the behaviour of PlaneAlert
+
+- `$` \- Tweet this column as #hashtag.
+- `#` \- Don't show on the website (it will ignore this for the ICAO field, which is always shown).
+- `$#` \- Don't show on the website; tweet as a #hashtag.
 
-- "$" \- Tweet this column as #hashtag
-- "#" \- Don't show on the website (it will ignore this for the ICAO field, which is always shown)
-- "$#"\- Don't show on the website, tweet as a #hashtag
+## Contributing
 
+As [explained above](#current-content), this repository contains five main databases to which people can contribute. The other databases are created automatically using [GitHub action](https://github.com/sdr-enthusiasts/plane-alert-db/actions/workflows/create_db_derivatives.yaml). As a result, please only suggest/make any changes to these main databases. Changes made to all other CSV files will be overwritten and lost.
 
-# To do / Ideas
+### To do / Ideas
 
-No 1 - Update USAF aircraft to use Reg/serial number in place of Ident/Callsign
+If you want to help below are some ideas you can implement:
+
+**No 1 - Update USAF aircraft to use Reg/serial number in place of Ident/Callsign.**
 
 - RAF Typhoon Display Team
 - Breitling Jet Team (not complete)
@@ -116,22 +141,22 @@ No 1 - Update USAF aircraft to use Reg/serial number in place of Ident/Callsign
 - Other US Gov Depts
 - B737 with Gravel Kits - Nolinor, Air Inuit, Canada North, Chron Aviation
 - Defense Helicopter Flying School
-- Identify more Aircraft owned by Religious organisations
+- Identify more aircraft owned by Religious organisations
 - Acrobat Ltd (Uk Gov Sock puppet ?)
 - UK Ministry of Defence
 - UK Border Force
 - Shuttleworth Collection
 - Other Warbirds
 - List of DA42 MPP / DA62 MPP Operators
 - Thales UK
-- Survey / Mapping Aircarft
+- Survey / Mapping aircarft
 - Other surveillance aircraft types
 - 750 Naval Air Squadron (Observers)
 - Coulson Aviation
 - Australian Aircraft called firebird (fire spotter and fighters)
 - S-64 Skycrane - list only partially completed (what is the list of names)
-- Japanese Flying Boats Shin Maywa US-2/US 1 (US2 are 9901 through 9907 - mode s ?)
-- Private Adversary Squadrons (Air Usa etc)
+- Japanese Flying Boats Shin Maywa US-2/US 1 (US2 are 9901 through 9907 - mode-s ?)
+- Private Adversary Squadrons (Air Usa etc.)
 - Operators of old Jets/Fighters (e.g. Hawker Huner Aviation)
 - Callspan Corp In-Flight Simulators
 - GAMA Avaiation (ex RAF spy planes)
@@ -142,19 +167,19 @@ No 1 - Update USAF aircraft to use Reg/serial number in place of Ident/Callsign
 - Babcock MCS Spain (and any other countries)
 - Lewis Hamilton Jet(s)
 - Open Skies Flights
-- Eurpoean Union
-- Scienctific / Weather planes
+- European Union
+- Scientific/Weather planes
 - Flight Precision Ltd (and Similar)
 - World Bank etc
 - Red Cross / MSF
-- Special Convertions e.g. Engine testbeds
+- Special Conversions e.g. Engine testbeds
 - Duxford and other historic flight collections
 - Historic Aircraft Flight Trust
-- Low volume Airliners / Special Models
+- Low-volume Airliners / Special Models
 - Football Teams and other sporting organisations
 - Beechcraft RC-12 Guardrail
 - Meteorological research flights
-- Film and Televison Companies
+- Film and Television Companies
 - News Choppers
 - RCAF Snowbirds
 - RAAF Roulettes
@@ -170,7 +195,7 @@ No 1 - Update USAF aircraft to use Reg/serial number in place of Ident/Callsign
 - Odd C130 Hercules - EC130H, EC130E, EC130J, MC130H, WC130J
 - AeroRescue
 - Air-Glaciers
-- Alci Avaiation
+- Alci Aviation
 - Baltic Bees Display Team
 - Bundesamt für Landestopografie
 - Bundesamt für Zivilluftfahrt BAZL
@@ -179,15 +204,15 @@ No 1 - Update USAF aircraft to use Reg/serial number in place of Ident/Callsign
 - Royal Flying Doctors Service
 - Top Aces Inc.
 - Russian FSB
-- Aircraft and companies in this article - https://www.cjr.org/watchdog/how-buzzfeed-news-revealed-hidden-spy-planes-in-us-airspace.php
+- Aircraft and companies in this article - <https://www.cjr.org/watchdog/how-buzzfeed-news-revealed-hidden-spy-planes-in-us-airspace.php>
 - Chapparral Air Group
 - Acorn Growth Companies
 - Aircraft owned/Operated by Sultan/State of Brunei (esp his very plush 747)
 - Aircraft - Lake Renegade
 - Special Hurons - MC-12W, MC-12S, RC-12H, RC-12N
 - Edgley Optika
-- Columbian C47 Gunships - Got 1 are there more ?
-- Artic and Antartic Aircraft (Got some - but are there more ?)
+- Columbian C47 Gunships - Got 1. Are there more?
+- Artic and Antarctic Aircraft (Got some - but are there more ?)
 - Thunder City (SA Company flying old jets)
 - Meta Special Aerospace
 - FAA and CAA
@@ -219,34 +244,23 @@ No 1 - Update USAF aircraft to use Reg/serial number in place of Ident/Callsign
 
 Any other idea's welcome.
 
-# Disclaimer, excuses and dodges
-
-This is not intented to be a definitive list, especially when it comes to aircraft models. Where the same model of aircraft is made by several manufacturers I wont always have the correct one. If you thought it was a Beechcraft King Air 200 and actualy it was a Textron Super King Air B200GT I won't be losing any sleep. There are other data sources (see below) if you want absolute accuracy. 
-
-# Data Sources
-
-This data has been gathered from far too many sources to mention, but some sites have been *really* useful.
-
-https://github.com/jbroutier/whatisflying-db
-
-https://www.flightdb.net/index.php
-
-http://www.rotorspot.nl/
-
-http://www.dtvmovements.co.uk/
-
-http://www.ads-b.nl/
-
-https://www.live-military-mode-s.eu/
-
-https://dictatoralert.org/ 
-
-http://www.j-hangarspace.jp/
+## Disclaimer, excuses and dodges
 
-https://scramble.nl/
+This is not intended to be a definitive list, especially when it comes to aircraft models. Where the same model of aircraft is made by several manufacturers I won't always have the correct one. If you thought it was a Beechcraft King Air 200 and actually it was a Textron Super King Air B200GT, I won't be losing any sleep. There are other data sources (see below) if you want absolute accuracy.
 
-https://www.foxtrotcharlie.ovh/
+## Data Sources
 
-https://www.planelogger.com/
+This data has been gathered from far too many sources to mention, but some sites have been _really_ useful:
 
-https://www.jetphotos.com/
+- <https://github.com/jbroutier/whatisflying-db>
+- <https://www.flightdb.net/index.php>
+- <http://www.rotorspot.nl/>
+- <http://www.dtvmovements.co.uk/>
+- <http://www.ads-b.nl/>
+- <https://www.live-military-mode-s.eu/>
+- <https://dictatoralert.org/>
+- <http://www.j-hangarspace.jp/>
+- <https://scramble.nl/>
+- <https://www.foxtrotcharlie.ovh/>
+- <https://www.planelogger.com/>
+- <https://www.jetphotos.com/>