Update readme.md for Initial Testing Project

FaradayRF / faradayio

FaradayRF TUN/TAP adapter

https://www.faradayrf.com

GNU General Public License v3.0

15 stars 6 forks source link

Update readme.md for Initial Testing Project #33

Closed kb1lqc closed 6 years ago

kb1lqc commented 6 years ago

The readme.md needs some updating to help understand what the project is. Update it for this initial push with testable software.

[x] Add installation instructions
[x] Add link to wiki
[x] Add simple module usage example placeholder

This will not include the use of a TUN/TAP program that will come in the next software project push. I have placed a placeholder for the simple module usage example because this really needs to use the threaded monitor which will come next.

kb1lqc commented 6 years ago

Looks great on the latest develop push with a new README.md file: https://github.com/kb1lqc/faradayio/tree/develop

kb1lqc commented 6 years ago

Closing as develop in my personal repository now has these commits in ready to be pulled into the FaradayRF master and develop branches when I do so in the next day or so.