From ae6c98a48da409d040604aeffb84a38155fb5bac Mon Sep 17 00:00:00 2001
From: Marc <foxtrot@malloc.me>
Date: Tue, 30 Nov 2021 22:39:26 +0000
Subject: Initial Commit

Signed-off-by: Marc <foxtrot@malloc.me>
---
 README.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2be5699
--- /dev/null
+++ b/README.md
@@ -0,0 +1,88 @@
+# libwifi
+802.11 Parsing / Generation library
+
+| Build Status                                                                       | OS    | Architecture |
+| ---------------------------------------------------------------------------------- | ------| ------------ |
+|![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).
+
+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.
+
+The library is fully documented with code comments in both the headers files and the code files, and also has doxygen HTML documentation in `docs/html`.
+
+## Building and Installing
+### Linux
+```
+$ mkdir build
+$ cd build
+$ cmake ..
+$ make
+$ 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/
+$ mkdir build
+$ cd build
+$ cmake ..
+$ make
+$ sudo iw <interface> set type monitor && sudo ip link set dev <interface> up
+$ ./test-program
+```
+
+
-- 
cgit 1.4.1