Browse Source

update README a bit

William Pitcock 3 years ago
parent
commit
edc0373c8f
1 changed files with 12 additions and 1 deletions
  1. 12
    1
      README.md

+ 12
- 1
README.md View File

@@ -1,2 +1,13 @@
1 1
 # aiobgp
2
-BGP client for Python and asyncio
2
+
3
+A Python BGP client utilising asyncio
4
+
5
+## Introduction
6
+
7
+The `aiobgp` library allows for programmatic manipulation of networks using the BGP protocol by implementing
8
+an AsyncIO ServerProtocol class.
9
+
10
+This allows for arbitrary programmatic learning and manipulation of a router's RIB table.  The possibilities
11
+are endless.
12
+
13
+This library assumes basic knowledge of the BGP4 protocol.  For details, read [RFC 1771](https://tools.ietf.org/html/rfc1771).