Skip to content
Permalink
Browse files

[Wiki] Update wiki pages

  • Loading branch information...
donsciarra committed Jul 24, 2019
1 parent 040e2af commit a448ebeff73934f5f8fafb78c4e8eb5ed196efc1
Showing with 42 additions and 38 deletions.
  1. +37 −32 README.md
  2. +5 −6 wiki/Home.md
@@ -1,5 +1,27 @@
# Table of Contents
* [Home](wiki/Home.md) -- Getting started: introduction to joynr
<p align="center">
<img src="graphics/joynr-logo.png" alt="joynr" width="300"/>
</p>

# What is joynr?
joynr is a web-based communication framework for Java, C++, and JavaScript applications
wanting to interact with other applications, no matter whether they're deployed on consumer
devices, vehicles, backend infrastructure or in the cloud.

joynr makes writing distributed applications easy, as it:

* takes care of determining the most appropriate communication paradigm to talk with the desired
end point
* provides a simple application programming interface to the joynr framework
* speeds up integration of new applications

... allowing you to focus on building your distributed application.

# How do I write joynr?
joynr is correctly written as "joynr". It is not an abbreviation nor a combination of words.

# Documentation
Have a peek at our documentation for more information:
* [Get to know joynr](wiki/Home.md) -- Introduction to joynr
* [Using joynr](wiki/using_joynr.md) -- General information about joynr
* [Franca IDL overview](wiki/franca.md) -- Introduction to Franca Interface Definition Language
used for modelling
@@ -14,37 +36,20 @@
* [JEE Developer Guide](wiki/jee.md) -- Developing JEE applications with joynr
* [Java Configuration Reference](wiki/JavaSettings.md) -- a reference of the available
configuration options for Java and JEE joynr applications
* [Glassfish Settings](wiki/Glassfish-settings.md) -- Settings you need to run joynr backend
services on Glassfish application servers
* C++
* [C++ Developer Guide](wiki/cplusplus.md) -- Developing C++ applications with joynr
* [C++ cluster-controller Settings](wiki/ClusterControllerSettings.md) -- C++ cluster-controller settings
* [JavaScript Developer Guide](wiki/javascript.md) -- Developing JavaScript applications with joynr
* [JavaScript Tutorial](wiki/JavaScriptTutorial.md) -- Make your first joynr JavaScript application
* [Radio App Tutorial](wiki/Tutorial.md) -- Make your first joynr app: define a communication
interface, implement a provider, and create a consumer.
* [Broadcast Tutorial](wiki/Broadcast-Tutorial.md) -- Learn about (selective) broadcasts and
implement a geocast.
* [Distribution](wiki/Distribution.md) -- How to get joynr.
* JavaScript
* [JavaScript Developer Guide](wiki/javascript.md) -- Developing JavaScript applications with joynr
* Tutorials
* [Radio App Tutorial](wiki/Tutorial.md) -- Make your first joynr app: define a communication
interface, implement a provider, and create a consumer
* [Broadcast Tutorial](wiki/Broadcast-Tutorial.md) -- Learn about (selective) broadcasts and
implement a geocast
* [JavaScript Tutorial](wiki/JavaScriptTutorial.md) -- Make your first joynr JavaScript application
* [Distribution](wiki/Distribution.md) -- How to get joynr
* [Infrastructure](wiki/infrastructure.md) -- Setting up the joynr infrastucture components for your environment
* [Glassfish Settings](wiki/Glassfish-settings.md) -- Settings you need to run joynr backend
services on Glassfish application servers.
* [Versioning scheme](wiki/JoynrVersioning.md) -- Meaning of joynr version numbers.
* [Release Notes](wiki/ReleaseNotes.md) -- All joynr releases and API changes at a glance.

# Overview
joynr is a web-based communication framework for Java, C++, and JavaScript applications
wanting to interact with other applications, no matter whether they're deployed on consumer
devices, vehicles, or backend infrastructure.

joynr makes writing distributed applications easy, as it:

* takes care of determining the most appropriate communication paradigm to talk with the desired
end point
* provides a simple application programming interface to the joynr framework
* speeds up integration of new applications

... allowing you to focus on building your distributed application.


Have a peek at our [documentation](wiki/Home.md) for more information!

<img src="graphics/joynr-logo.png" alt="joynr" style="width: 200px;"/>
* [Versioning scheme](wiki/JoynrVersioning.md) -- Meaning of joynr version numbers
* [Release Notes](wiki/ReleaseNotes.md) -- All joynr releases and API changes at a glance
@@ -26,7 +26,7 @@ transport middleware.
* For example, using joynr:

* Web Sockets may be used between devices
* HTTP Long Polling may be used to the backend
* MQTT or HTTP Long Polling may be used to the backend

* Since joynr is transport middleware agnostic, operations may swap out middleware implementations and infrastructure without requiring application rewrites. For example, a joynr network could replace HTTP Long Polling with Web Sockets without requiring the applications using joynr to be modified or even recompiled.

@@ -37,7 +37,7 @@ transport middleware.
* joynr defines programming interfaces to existing Public Key Infrastructure, in order to reuse infrastructure
already in place for other personalisation and security use cases.

### Language Bindings for C++, Java and JavaScript
### Language Bindings for C++, Java, JavaScript and TypeScript

* joynr supports the C++, Java and JavaScript languages in order to enable
developers to target a wide range of platforms, all the way from backend
@@ -53,7 +53,7 @@ joynr supports all three of the most common calling paradigms supported by moder
* Filtered Broadcast or event subscriptions, while similar to pub/sub, allow a richer modelling of events that do not map to a single attribute value

## Layered architecture
joynr employs the following layers in its implementations, decreasing in level of abstraction:
joynr employs the following layers in its implementations, decreasing in level of abstraction:

**Formally specified interface**

@@ -75,11 +75,10 @@ Mapping of middleware-agnostic messaging to a specific transport middleware impl

**Messaging implementation**


Open Source industry standard implementations are preferred.
Currently:

* Atmosphere-based via HTTP
* mosquitto/paho/hivemq-mqtt-client for MQTT
* WebSockets

**OSI Transport Layer**
@@ -90,7 +89,7 @@ TCP, Sockets, etc. depending on the needs of the messaging implementation.
Per default, joynr ships with a REST-based messaging middleware that addresses requirements such as reliability, stability, performance, memory footprint, CPU usage, and operating system independence required of distributed applications running on embedded devices over unreliable networks.

## Releases
See the [release notes](ReleaseNotes.md).
See the [release notes](ReleaseNotes.md) and our [versioning scheme](JoynrVersioning.md).

## Further Reading

0 comments on commit a448ebe

Please sign in to comment.
You can’t perform that action at this time.