diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/README.md b/README.md index bd036d8..542c061 100644 --- a/README.md +++ b/README.md | |||
@@ -1,14 +1,15 @@ | |||
1 | # libwifi | 1 | # libwifi |
2 | 802.11 Parsing / Generation library | 2 | 802.11 Parsing / Generation library |
3 | 3 | ||
4 | | Build Status | OS | Architecture | | 4 | | Build Status | OS | |
5 | | ---------------------------------------------------------------------------------- | ------| ------------ | | 5 | |---------------------------------------------------------------------------------------|-------| |
6 | | | Linux | x86_64 | | 6 | | | Linux | |
7 | | | macOS | | ||
7 | 8 | ||
8 | ## What is this? | 9 | ## What is this? |
9 | 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)) on Linux with a few lines of straight forward code (see the [Examples section](#examples) below). | 10 | 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)) on Linux and macOS with a few lines of straight forward code (see the [Examples section](#examples) below). |
10 | 11 | ||
11 | 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. | 12 | libwifi has been tested across Linux and macOS, on x86, MIPS and ARM, and 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. |
12 | 13 | ||
13 | The library is fully documented with code comments in both the headers files and the code files. | 14 | The library is fully documented with code comments in both the headers files and the code files. |
14 | 15 | ||