Skip to content

Commit

Permalink
trying out internal links
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander Goedde committed May 14, 2016
1 parent 4da92fb commit 34758a5
Show file tree
Hide file tree
Showing 15 changed files with 96 additions and 929 deletions.
34 changes: 28 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,15 @@ WAMP provides asynchronous **Remote Procedure Calls** and **Publish & Subscribe*

**Autobahn**|JS runs on both **Web browsers** and **[Node.js](http://nodejs.org/)**.

WAMP enables application architectures with application code distributed freely across processes and devices according to functional aspects. Since WAMP implementations exist for multiple languages, WAMP applications can be polyglott. Application components can be implemented in a language and run on a device which best fit the particular use case.
## What can I do with this stuff?

**Autobahn|JS** makes **distributed, realtime Web applications easy**: it provides the infrastructure for both **distributing live updates** to all connected clients (using the PubSub messaging pattern) and for **calling remote procedures** in different backend components (using RPC).

It is ideal for distributed, multi-client and server applications, such as multi-user database-drive business applications, real-time charts, sensor networks (IoT), instant messaging or MMOGs (massively multi-player online games).

The protocol that **Autobahn|JS** uses, WAMP, enables application architectures with application code **distributed freely across processes and devices** according to functional aspects. All WAMP clients are equal in that they can publish events and subscribe to them, can offer a procedure for remote calling and call remote procedures.

Since WAMP implementations exist for **multiple languages**, this extends beyond JavaScript clients: WAMP applications can be polyglot. Application components can be implemented in a language and run on a device which best fit the particular use case. Applications can span the range from embedded IoT sensors right to mobile clients or the browser - using the same protocol.

## Show me some code

Expand Down Expand Up @@ -54,6 +62,20 @@ connection.onopen = function (session) {
connection.open();
```

Features
--------

* supports WAMP v2, works with any WAMP server
* works both in the browser and Node.js
* provides asynchronous RPC and PubSub messaging patterns
* uses WebSocket or HTTP long-poll as transport
* easy to use Promise-based API
* pluggable promises/deferreds: use [when.js](https://github.com/cujojs/when) (built-in), [jQuery](http://api.jquery.com/category/deferred-object/) , [Dojo](http://dojotoolkit.org/reference-guide/1.7/dojo/Deferred.html), ECMA Script 6 or others
* no dependencies
* small size (244kB source, 111kB minified, 33kB compressed)
* Open-Source (MIT License)


## Get it

### Browser Development
Expand Down Expand Up @@ -86,12 +108,12 @@ AutobahnJS is available via the Node package manager [here](https://www.npmjs.or

## More information

For more information, take a look at the [project documentation](http://autobahn.ws/js). This provides:
For more information, take a look at the [project documentation](/doc/). This provides:

* [a quick 'Getting Started'](http://autobahn.ws/js/gettingstarted.html)
* [tutorials on RPC and PubSub](http://autobahn.ws/js/tutorial.html)
* [a list of all examples in this repo](http://autobahn.ws/js/examples_overview.html)
* [a full API reference](http://autobahn.ws/js/reference.html)
* [a quick 'Getting Started'](/doc/gettingstarted.md)
* [a basic introduction to programming with Autobahn|JS](/doc/programming.md)
* [a list of all examples in this repo](/doc/examples_overview.md)
* [a full API reference](/doc/reference.md)


## Get in touch
Expand Down
23 changes: 10 additions & 13 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
# Documentation

The **Autobahn**|JS documentation is generated using [Sphinx](http://sphinx.pocoo.org/) and the generated documentation is hosted [here](http://autobahn.ws/js).
If you're new to Autobahn|JS, then please take a look at [Getting Started](gettingstarted.md) first.

You may also want to read up a bit on the [Web Application Messaging Protocol (WAMP)](http://wamp-proto.org/why/) which it implements.

## Generate
And finally, we suggest visiting the [Crossbar.io site](http://crossbar.io). Crossbar.io is a WAMP router maintained by the people behind Autobahn|JS, and the documentation there includes examples for some aspects of building WAMP applications - all of which use Autobahn|JS.

You will need to have Python and [SCons](http://www.scons.org/) installed. To install the rest of the build dependencies
## Table of Contents

```sh
make install_deps
```


Then, to get help on available build targets, just type

```sh
make
```
* [Getting Started](gettinstarted.md)
* [Programming](programming.md) - A quick introduction to using Autobahn|JS in your applications
* [Reference](reference.md) - A full reference to the Autobahn|JS API
* [Examples Overview](examples_overview-md) - An overview of the available code examples
* [Building](building.md) - Instructions for how to build Autobahn|JS from source

2 changes: 1 addition & 1 deletion doc/building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Building Autobahn|JS
====================

To build |ab| for use in browsers, you will need
To build **Autobahn|JS** for use in browsers, you will need

* `Node.js <http://nodejs.org/>`_
* `Google Closure Compiler <http://dl.google.com/closure-compiler/compiler-latest.zip>`_
Expand Down
Loading

0 comments on commit 34758a5

Please sign in to comment.