diff --git a/.gitignore b/.gitignore index 4698b32..79b05d4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,6 @@ test.py .DS_Store *.sass-cache -hyperglass/config/*.toml -hyperglass/.flask_cache -.flask_cache # # Github Default from https://github.com/martinohanlon/flightlight/issues/1 # Byte-compiled / optimized / DLL files diff --git a/README.md b/README.md index 65da6a9..3411fbb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - + **hyperglass** is a modern network looking glass application. A looking glass is typically implemented by network service providers as a way of providing customers, peers, and partners with a way to easily view elements of, or run tests from the provider's network. @@ -14,7 +14,7 @@ ## Features - BGP Route, BGP Community, BGP AS Path, Ping, Traceroute -- Full IPv6 support +- Full frontend and backend IPv6 support - [Netmiko](https://github.com/ktbyers/netmiko)-based connection handling for traditional network devices - [FRRouting](https://frrouting.org/) support via [hyperglass-frr](https://github.com/checktheroads/hyperglass-frr) REST API - Customizable commands for each query type by vendor @@ -24,7 +24,7 @@ - Optional SSH Proxy to further direct secure router access - Configurable IP/Prefix "blacklist" to prevent lookup of sensitive prefixes - Configurable rate limiting, powered by [Flask-Limiter](https://github.com/alisaifee/flask-limiter) -- Query response caching with configurable cache timeout, powered by [Flask-Caching](https://github.com/sh4nks/flask-caching) +- Query response caching with configurable cache timeout - [Prometheus](https://prometheus.io/) metrics for query statistics tracking ## Documentation @@ -33,7 +33,7 @@ Documentation can be found [here](https://hyperglass.readthedocs.io), or in the ## Preview -For screenshots, see [here](screenshots.md), or the `screenshots/` directory. +For screenshots, see [here](https://hyperglass.readthedocs.io/screenshots/). ## Platform Support diff --git a/logo.png b/logo.png new file mode 100644 index 0000000..ddf9632 Binary files /dev/null and b/logo.png differ