Docs and install - Githubissues

Lvl4Sword / Killer

🔪 System tamper detector for USB, Bluetooth, AC, Battery, Disk Tray, and Ethernet.

https://pypi.org/project/killer/

GNU Affero General Public License v3.0

71 stars 11 forks source link

Docs and install #30

Closed GhostofGoes closed 6 years ago

GhostofGoes commented 6 years ago

Summary

Added basic install and usage instructions
Updated and expanded the developer setup instructions
Added badges for current PyPI version and number of PyPI downloads
Added python_requires to setup.py. This ensures users don't accidentally install on the wrong version of Python (and prevents the GitHub issues we've all seen where someone accidentally uses pip instead of pip3 on Linux and reports the thing not working...).

See individual commits for details. This PR doesn't necessitate a version bump unless you want to.