Skip to content

Commit

Permalink
Update README for v1.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
watal committed Feb 22, 2023
1 parent 86b7c2c commit 3a068a7
Showing 1 changed file with 22 additions and 9 deletions.
31 changes: 22 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,36 @@
[![Releaser](https://github.com/nttcom/pola/actions/workflows/release.yml/badge.svg)](https://github.com/nttcom/pola/actions)
[![Go Report Card](https://goreportcard.com/badge/nttcom/pola)](https://goreportcard.com/report/github.com/nttcom/pola)
[![Go Reference](https://pkg.go.dev/badge/github.com/nttcom/pola.svg)](https://pkg.go.dev/github.com/nttcom/pola)
[![Go version](https://img.shields.io/github/go-mod/go-version/nttcom/pola)](https://go.dev/)
[![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE)

PCEP Library and Stateful PCE Implementation with Go

## Installation & Use
- [Getting Started](docs/sources/getting-started.md)
- Examples (powered by [Containerlab](https://containerlab.dev/)/[Tinet](https://github.com/tinynetwork/tinet))
- [SR-MPLS Example](examples/tinet/sr-mpls_te_l3vpn)
- [SRv6 Example](examples/containerlab/srv6_te_l3vpn)
## Features
* Supports SRv6 and SR-MPLS
* Active stateful PCE (PCInitiate, PCUpdate, etc.)
* Provide dynamic/explicit SR policy defined as YAML
* Dynamic path: CSPF based on [GoBGP](https://github.com/osrg/gobgp) BGP-LS TED
* Explicit path: Define and provide any Segment List

## Interoperability
- Cisco IOS-XR
- Junos
- FRRouting
### SR-MPLS
* IOS-XR
* Junos
* FRRouting

### SRv6
* Junos

## Installation & Use
* [Getting Started](docs/sources/getting-started.md)
* Examples (powered by [Containerlab](https://containerlab.dev/)/[Tinet](https://github.com/tinynetwork/tinet))
* [SR-MPLS Example](examples/tinet/sr-mpls_te_l3vpn)
* [SRv6 Example](examples/containerlab/srv6_te_l3vpn)

## Contributing
Please fork the repository and create a pull-request.
See [CONTRIBUTING](https://github.com/nttcom/pola/blob/main/CONTRIBUTING.md).
Please fork the repository and create a Pull Request.
We welcome and appreciate your contribution.

## Licensing
Expand Down

0 comments on commit 3a068a7

Please sign in to comment.