Commit ac0ffdc7 authored by Kevin Di Lallo's avatar Kevin Di Lallo
Browse files

updated README.md

parent c020b0bd
Loading
Loading
Loading
Loading
+27 −15
Original line number Diff line number Diff line
@@ -2,15 +2,24 @@

------

> **_NEW!_**  --  Reaching out to the team is now easier than ever:  -- just initiate a [discussion](https://github.com/InterDigitalInc/AdvantEDGE/discussions)
**_What's New!_** 

:zap: **v1.7.0 cool features :sunglasses: :point_right: [**process lifecycle API**](https://github.com/InterDigitalInc/AdvantEDGE/wiki/overview-features#process-lifecyle) and [**cellular connectivity API**](https://github.com/InterDigitalInc/AdvantEDGE/wiki/overview-features#cellular-connectivity-control) - open-up new edge experiments**

:zap:  **Wiki refresh was overdue :shamrock: Hope the :sparkles: new structure & [**Sitemap**](https://github.com/InterDigitalInc/AdvantEDGE/wiki/project-sitemap) :sparkles: make it easier to navigate**

:zap: **"_Old New_" :wink: you can still easily reach out to the team by initiating [:octocat: **Discussion**](https://github.com/InterDigitalInc/AdvantEDGE/discussions)**

------

## What is AdvantEDGE?

AdvantEDGE is a Mobile Edge Emulation Platform (MEEP) that runs on Docker & Kubernetes.

AdvantEDGE provides an emulation environment, enabling experimentation with Edge Computing Technologies, Applications, and Services.  The platform facilitates exploring edge / fog deployment models and their impact on applications and services in short and agile iterations.

## Motivation

#### Motivation

- [x] **Accelerate Mobile Edge Computing adoption**
- [x] **Help Discover new edge application use cases & services**
@@ -19,27 +28,30 @@ AdvantEDGE provides an emulation environment, enabling experimentation with Edge
  - How do network characteristics (such as latency, jitter, and packet loss) impact my application or service?
  - How will my application behave when the user moves within and across access networks?

## Getting Started
#### Intended Users

Complete AdvantEDGE documentation is available in the [AdvantEDGE Wiki](https://github.com/InterDigitalInc/AdvantEDGE/wiki)
- [x] **Edge Application Developers**
- [x] **Edge Network and Service Designers**
- [x] **Edge Researchers**
- [x] **Technologists that are simply interested learning how the Edge works**

To get started using AdvantEDGE, the following steps are needed:
- Set up runtime environment (Ubuntu/Dockers/Kubernetes/Helm)
- Clone AdvantEDGE repo
- Install & Configure meepctl tool
- Deploy AdvantEDGE micro-services
## Getting started

Step-by-step details are available in the [Wiki](https://github.com/InterDigitalInc/AdvantEDGE/wiki#getting-started)
[:one: :heavy_minus_sign: **Familiarize with Architecture and Features**](https://github.com/InterDigitalInc/AdvantEDGE/wiki/overview-architecture)

## How to Contribute
As of June 2020, we can accept contributions to the project.
[:two: :heavy_minus_sign: **Setup environment**](https://github.com/InterDigitalInc/AdvantEDGE/wiki/env-hw)

[:three: :heavy_minus_sign: **Deploy platform**](https://github.com/InterDigitalInc/AdvantEDGE/wiki/mgmt-workflow)

If you like this project and would like to participate in its evolution, you can find information on contributing [here](https://github.com/InterDigitalInc/AdvantEDGE/blob/master/CONTRIBUTING.md)
[:four: :heavy_minus_sign: **Start using AdvantEDGE**](https://github.com/InterDigitalInc/AdvantEDGE/wiki/usage-workflow)

## How to Contribute
If you like this project and would like to participate in its evolution, you can find information on contributing [**here**](https://github.com/InterDigitalInc/AdvantEDGE/blob/master/CONTRIBUTING.md)

We still welcome feedback and improvement suggestions via Git issue in the repo for bugs or request enhancements.
We welcome questions, feedback and improvement suggestions via [:octocat:**Discussion**](https://github.com/InterDigitalInc/AdvantEDGE/discussions) and bugs reporting via [:octocat: **Issues**](https://github.com/InterDigitalInc/AdvantEDGE/issues)

Hope to hear from you...

## Licensing

AdvantEDGE is licensed under under the [Apache License, Version 2.0](https://github.com/InterDigitalInc/AdvantEDGE/blob/master/LICENSE)
AdvantEDGE is licensed under under the [**Apache License, Version 2.0**](https://github.com/InterDigitalInc/AdvantEDGE/blob/master/LICENSE)