Skip to content

Review and improve README documentation #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
trick77 merged 1 commit into from
Jan 9, 2026
+5 −5
Merged

Review and improve README documentation #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Community-maintained metadata for autonomous systems with missing or incorrect W

## What is this?

Sometimes AS are announcing prefixes but have:
Sometimes an AS is announcing prefixes but has:
- No WHOIS records
- Missing country codes in WHOIS
- Incorrect inferred metadata
Expand All @@ -13,14 +13,14 @@ This overlay fills those gaps and is automatically imported into [ipverse](https

## How it works

When WHOIS data is missing, ipverse uses inference to discover metadata automatically. When that inference is wrong or incomplete, this overlay provides corrections. Once authoritative WHOIS records appear, overlay entries are typically removed
When WHOIS data is missing, ipverse uses inference to discover metadata automatically. When that inference is wrong or incomplete, this overlay provides corrections. Once authoritative WHOIS records appear, overlay entries are typically removed.

## Missing metadata

The file `missing.json` lists AS with incomplete metadata. Each entry has a `missing` field indicating what's missing:
The file `missing.json` lists autonomous systems with incomplete metadata. Each entry has a `missing` field indicating what's missing:

- `"all"` - AS with no metadata at all
- `"country"` - AS with metadata but missing country code
- `"all"` - Autonomous systems with no metadata at all
- `"country"` - Autonomous systems with metadata but missing country code

This file is auto-generated. See [CONTRIBUTING.md](CONTRIBUTING.md) for how to use it.

Expand Down