# Welcome to Simple Bandwidth Scanner’s documentation!

## User main documentation

Included in the repository root and in `sbws` Debian package:

- Readme
- Installing Simple Bandwidth Scanner
- Deploying Simple Bandwidth Scanner
- Contributing to Simple Bandwidth Scanner
- Changelog
- Authors
- Simple Bandwidth Scanner - SBWS(1)
- Simple Bandwidth Scanner - SBWS.INI(5)

## Developer/technical documentation

Included in the docs directory and in `sbws-doc` Debian package:

- Simple Bandwidth Scanner technical details
- Frequently Asked Questions (FAQ)
- Glossary
- Roadmap
- sbws scanner tor configuration
- Installing tests dependencies and running tests
- Installing documentation dependendencies and building it
- The `state.dat` file
- How sbws configuration works internally
- Default Config
- UML diagrams
- sbws package API

Proposals:

- Switching from helpers to HTTP(S)

## Indices and tables

- Index
- Module Index
- Search Page