summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLuca Muscariello <muscariello@ieee.org>2020-02-14 13:36:37 +0100
committerLuca Muscariello <muscariello@ieee.org>2020-02-15 18:33:22 +0100
commit64a22cf6f812fbdd1b5a0eb184b178d88c6a329f (patch)
tree095b884e1f066cad19f3fa76be16c1c102c6c075 /README.md
parentc77f6b381fe29331c72f8abc6fdd4a4d3286f87b (diff)
[HICN-521] Documentation update
Change-Id: I3ef51af521b53512e589eaf5bb5c0852a638baf5 Signed-off-by: Luca Muscariello <muscariello@ieee.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 21 insertions, 10 deletions
diff --git a/README.md b/README.md
index 512244f4a..3ca08b869 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
-Hybrid Information-Centric Networking (hICN)
-========================
+# Hybrid Information-Centric Networking (hICN)
## Introduction
+
hicn is an open source implementation of Cisco's hICN. It includes a network stack, that implements
ICN forwarding path in IPv6, and a transport stack that implements two main transport protocols and
a socket API. The transport protocols provide one reliable transport service implementaton and a
@@ -28,19 +28,30 @@ local namespace (local face management).
## Supported platforms
- Ubuntu 16.04 LTS (amd64)
-- Ubuntu 18.04 LTS (amd64)
+- Ubuntu 18.04 LTS (amd64, arm64)
- CentOS 7 (x86_64)
-- Android 8
-- iOS 12
-- macOS 10.12
+- Android 10
+- iOS 13
+- macOS 10.15
- Windows 10
## Binaries
-# Ubuntu 16/18 (amd64) and CentOS 7 (x86_64)
-https://packagecloud.io/fdio/release
-## Release note
-The current master branch provides the 19.08 release which is compatible with the 19.08 VPP stable.
+### Ubuntu 16/18 (amd64) and CentOS 7 (x86_64)
+
+<https://packagecloud.io/fdio/release>
+
+### Docker
+
+<https://hub.docker.com/u/icnteam>
+
+### Vagrant
+
+<https://app.vagrantup.com/icnteam/>
+
+### Release note
+
+The current master branch provides the latest release which is compatible with the latest VPP stable.
No other VPP releases are supported nor maintained. At every new VPP release distribution hicn
master branch is updated to work with the latest stable release. All previous stable releases
are discontinued and not maintained. The user who is interested in a specific release can always