From 70963323b91d8f88e48bf6d4711dd7d4bef48343 Mon Sep 17 00:00:00 2001 From: Marc Date: Fri, 3 Dec 2021 03:25:18 +0000 Subject: misc: Update README to point to website for feature checklist. --- README.md | 51 +-------------------------------------------------- 1 file changed, 1 insertion(+), 50 deletions(-) diff --git a/README.md b/README.md index 2be5699..bdf11a4 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ |![X86_64](https://github.com/libwifi/libwifi/actions/workflows/x86_64.yml/badge.svg) | Linux | x86_64 | ## What is this? -libwifi is a C library with a permissive license for generating and parsing a wide variety of 802.11 wireless frames (see the [Feature Checklist](#feature-checklist) below) on Linux with a few lines of straight forward code (see the [Examples section](#examples) below). +libwifi is a C library with a permissive license for generating and parsing a wide variety of 802.11 wireless frames (see the [Feature Checklist](https://libwifi.so/features) below) on Linux with a few lines of straight forward code (see the [Examples section](#examples) below). It is written with a simple-to-use approach while also exposing features that allow more advanced use, with clean and readable code being a priority. Other goals of the library include cross-architecture support, clean compilation without warnings and strict error checking. @@ -25,55 +25,6 @@ $ sudo make install ## Examples Some examples are available in the `examples/` directory, which show the general flow of how libwifi is used to generate and parse different types of 802.11 frame. -## Feature Checklist -- Generation - - [X] Radiotap Header - - Management - - [X] Association Request - - [X] Association Response - - [X] Reassociation Request - - [X] Ressociation Response - - [X] Probe Request - - [X] Probe Response - - [X] Timing Advertisement - - [X] Beacon - - [X] ATIM - - [X] Disassociation - - [X] Deauthentication - - [X] Action - - [X] Action No ACK - - Control - - [X] RTS (Request-to-Send) - - [X] CTS (Clear-to-Send) - - Data - - [ ] Data Frame - - [ ] QoS Data Frame - - [ ] EAPOL - -- Parsing - - [X] Radiotap Header - - Management - - [X] Association Request - - [X] Association Response - - [X] Reassociation Request - - [X] Ressociation Response - - [X] Probe Request - - [X] Probe Response - - [ ] Timing Advertisement - - [X] Beacon - - [ ] ATIM - - [X] Disassociation - - [X] Deauthentication - - [ ] Action - - [ ] Action No ACK - - Control - - [ ] RTS (Request-to-Send) - - [ ] CTS (Clear-to-Send) - - Data - - [X] Data Frame (Partial) - - [X] QoS Data Frame (Partial) - - [X] EAPOL - ## Running Tests ``` $ cd tests/ -- cgit 1.4.1