summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f5b8172
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# bgp-java
+BGP 4 Connector that can be used for network analysis.
+
+## Usage
+```java
+BGPServer server = new BGPServer();
+server.getSessionConfigurations().add(new BGPSessionConfiguration(
+ "demosession",
+ 1234,
+ ip("1.2.3.4"),
+ 4321,
+ ip("4.3.2.1"),
+ new BGPListener() {
+ public void onOpen(BGPSession session) {
+ // DO WHAT YOU WANT
+ }
+ public void onUpdate(BGPSession session, BGPUpdate update) {
+ // DO WHAT YOU WANT
+ }
+ public void onClose(BGPSession session) {
+ // NOT YET IMPLEMENTED
+ }
+ }
+));
+server.run();
+``` \ No newline at end of file