Skip to content

Commit

Permalink
docs: clarify readme
Browse files Browse the repository at this point in the history
  • Loading branch information
natesales committed Jun 24, 2022
1 parent 31f6aab commit 7549e48
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 10 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
<img alt="Pathvector Logo" src="https://pathvector.io/img/black-border.svg" height="200" />

Pathvector is a declarative edge routing platform that automates route optimization and control plane configuration with secure and repeatable routing policy.
Pathvector is a declarative edge routing platform that automates route optimization and control plane configuration with
secure and repeatable routing policy.

[![Docs](https://img.shields.io/static/v1?label=docs&message=pathvector.io&color=9407cd&style=for-the-badge)](https://pathvector.io)
[![Go Report](https://goreportcard.com/badge/github.com/natesales/pathvector?style=for-the-badge)](https://goreportcard.com/report/github.com/natesales/pathvector)
[![Codecov](https://img.shields.io/codecov/c/github/natesales/pathvector?style=for-the-badge)](https://app.codecov.io/gh/natesales/pathvector)
[![CII Best Practices](https://img.shields.io/static/v1?label=CII%20Best%20Practices&message=passing&color=green&style=for-the-badge)](https://bestpractices.coreinfrastructure.org/projects/5328)

Check out the [installation page](https://pathvector.io/docs/installation),
[practical examples](https://pathvector.io/docs/examples), and
[full configuration manual](https://pathvector.io/docs/configuration).

## Features

* Robust BGP route filtering with RPKI, IRR, and import limits automatically configured from PeeringDB.
* Automatic route optimization by enriching the standard set of BGP attributes with latency and packet loss metrics.
* Robust BGP route filtering with RPKI, IRR, AS path, and route limits all automatically configured from PeeringDB
* Auxiliary protocol support with BFD, VRRP, and MRT
* Automatic route optimization by enriching the standard set of BGP attributes with latency and packet loss metrics
* Declarative configuration model: Want to track your changes? Just commit your file to version control.
* Data-plane Agnostic: Pathvector works on servers, network switches, embedded devices, etc.
* Data-plane agnostic: Pathvector works on servers, network switches, embedded devices, etc
* Extensible plugin API
16 changes: 11 additions & 5 deletions docs/docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,22 @@ sidebar_position: 1

<img alt="Pathvector Logo" src="https://pathvector.io/img/black-border.svg" height="200" />

Pathvector is a declarative edge routing platform that automates route optimization and control plane configuration with secure and repeatable routing policy.
Pathvector is a declarative edge routing platform that automates route optimization and control plane configuration with
secure and repeatable routing policy.

[![Docs](https://img.shields.io/static/v1?label=docs&message=pathvector.io&color=9407cd&style=for-the-badge)](https://pathvector.io)
[![Go Report](https://goreportcard.com/badge/github.com/natesales/pathvector?style=for-the-badge)](https://goreportcard.com/report/github.com/natesales/pathvector)
[![Codecov](https://img.shields.io/codecov/c/github/natesales/pathvector?style=for-the-badge)](https://app.codecov.io/gh/natesales/pathvector)
[![CII Best Practices](https://img.shields.io/static/v1?label=CII%20Best%20Practices&message=passing&color=green&style=for-the-badge)](https://bestpractices.coreinfrastructure.org/projects/5328)

Check out the [installation page](https://pathvector.io/docs/installation),
[practical examples](https://pathvector.io/docs/examples), and
[full configuration manual](https://pathvector.io/docs/configuration).

## Features

* Robust BGP route filtering with RPKI, IRR, and import limits automatically configured from PeeringDB.
* Automatic route optimization by enriching the standard set of BGP attributes with latency and packet loss metrics.
* Robust BGP route filtering with RPKI, IRR, AS path, and route limits all automatically configured from PeeringDB
* Auxiliary protocol support with BFD, VRRP, and MRT
* Automatic route optimization by enriching the standard set of BGP attributes with latency and packet loss metrics
* Declarative configuration model: Want to track your changes? Just commit your file to version control.
* Data-plane Agnostic: Pathvector works on servers, network switches, embedded devices, etc.
* Data-plane agnostic: Pathvector works on servers, network switches, embedded devices, etc
* Extensible plugin API

0 comments on commit 7549e48

Please sign in to comment.