From fa9192d18c0c5839c44f7329cb4236a700f3e133 Mon Sep 17 00:00:00 2001 From: Be Date: Fri, 1 Mar 2024 11:01:04 +0100 Subject: [PATCH] Update readme --- README.md | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index e99fbfb..93cd761 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,17 @@ -# Get network lists from AS name or Network name +# AS Network List -## Description +This repository contains two Python scripts that allow you to retrieve network lists based on either an Autonomous System (AS) name or a Network name. -* If you know AS name, use the script `network_list_from_as.py` to get the list of networks. -* If you know the network name, use the script `network_list_from_netname.py` to get the list of networks. +## Features +- `network_list_from_as.py`: Retrieves a list of networks associated with a given AS name. +- `network_list_from_netname.py`: Retrieves a list of networks associated with a given Network name. -**Note:** This scripts has been tested on MacOS and Linux. +These scripts have been tested on MacOS and Linux. ## Prerequisites -- Python 3: You can download it from the [official website](https://www.python.org/downloads/). +- Python 3: Download it from the [official website](https://www.python.org/downloads/). ## Installation @@ -32,7 +33,9 @@ ./requirements.sh ``` -## Usage of the `network_list_from_as.py` script +## Usage + +### `network_list_from_as.py` 1. Run the script with the AS number as an argument: @@ -40,39 +43,39 @@ ./network_list_from_as.py AS61280 ``` -2. To disable all output except the prefixes, use the `--quiet` or `-q` switch: +2. To suppress all output except the prefixes, use the `--quiet` or `-q` switch: ```bash ./network_list_from_as.py AS61280 -q ``` -3. To print a help message, use the `-h` or `--help` switch: +3. To display a help message, use the `-h` or `--help` switch: ```bash ./network_list_from_as.py --help ``` -## Usage of the `network_list_from_netname.py` script +### `network_list_from_netname.py` -1. Run the script with the list of network names in a file as an argument: +1. Run the script with a file containing a list of network names as an argument: ```bash ./network_list_from_netname.py files/blacklist4.txt ``` -2. Run the script with the list of network names in the github repository as an argument: +2. Run the script with a URL to a file in a GitHub repository as an argument: ```bash ./network_list_from_netname.py https://github.com/AntiZapret/antizapret/blob/master/blacklist4.txt ``` - or better use the raw file link: + Or better use the raw file link: ```bash ./network_list_from_netname.py https://raw.githubusercontent.com/AntiZapret/antizapret/master/blacklist4.txt ``` -3. To print a help message, use the `-h` or `--help` switch: +3. To display a help message, use the `-h` or `--help` switch: ```bash ./network_list_from_netname.py --help @@ -80,5 +83,5 @@ ## Screenshots -![Screenshot](https://github.com/C24Be/AS_Network_List/assets/153936414/574b072c-9104-4e02-b2c0-3609433bdfc4) -image +image +image