Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

testing that PRs work on GitHub #1

Merged
merged 1 commit into from
Apr 9, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
testing that PRs work on GitHub
  • Loading branch information
barbibulle committed Apr 9, 2020
commit 16b5879b0290a1182beb820e5950a8e0ff1a4dc4
37 changes: 24 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,29 @@ Project Golden Gate

![Golden Gate bridge image - public domain photo via Good Free Photos](docs/src/golden_gate_bridge.jpg)

!!! warning "Work In Progress"

This documentation is not yet complete. As we migrate the project from
an internal project to one that can be shared with others, we are busy
migrating some of the documentation from internal Wiki pages, Google docs
and slide decks.
> :warning: **Work In Progress**
> This documentation is not yet complete. As we migrate the project from
> an internal project to one that can be shared with others, we are busy
> migrating some of the documentation from internal Wiki pages, Google docs
> and slide decks.

Golden Gate is a portable cross-platform framework that offers reliable and
secure network communication between different combinations of embedded
devices, mobile applications and desktop applications.
The framework provides developers with a familiar model, allowing them to
implement their functionality the same way they would in other networked
environments, leveraging familiar standards like CoAP, WebSockets, HTTP, MQTT,
TLS, and TCP/UDP/IP, even when the underlying operating system or transport
doesn't natively support those.
It can run in many environments, from embedded systems with very limited
resources like wearables and IoT devices, to mobile and desktop.
resources like wearables and IoT devices, to mobile and desktop.
The initial focus is on Bluetooth Low Energy (BLE) connections, but the
framework is general in nature, it is designed to work with any type of
transport. BLE APIs on mobile operating systems like iOS and Android, as
well as most embedded APIs, only offer the limited functionality of BLE GATT;
so the Golden Gate framework's networking stack extends that low-level access,
allowing a complete IP-based stack to be layered on top of it.

The project consists of:

* A core library written in C
Expand All @@ -26,17 +37,17 @@ The project consists of:
* Documentation

By building the core libraries and sample applications included in the
project's repo, you'll be able to start experimenting right away with
different combinations of devices connecting and communicating with each
other, including:
project, you'll be able to start experimenting right away with different
combinations of devices connecting and communicating with each other with
CoAP clients and servers, over a Bluetooth or WiFi connection, including:
* iPhones and iPads
* Android phones and tablets
* Desktops and laptops (macOS, Linux, Windows)
* Embedded development boards (nRF52840-DK, Espressif ESP32, ...)

And by integrating the libraries in your own app or IoT device,
leveraging some of the examples included in the project, you will be able to
start building your own communicating applications and services.
By integrating the library in your own app or IoT device, leveraging some of
the examples included in the project, you will be able to start building your
own communicating applications and services.

Where To Start
--------------
Expand Down