Skip to content

Commit

Permalink
github readme reduced, small fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexander Goedde committed Mar 25, 2014
1 parent eba3d44 commit eac7ead
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 13 deletions.
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
AutobahnAndroid
===============
# AutobahnAndroid

AutobahnAndroid implements **[The WebSocket Protocol](http://tools.ietf.org/html/rfc6455)** and **[The WebSocket Application Messaging Protocol (WAMP)](http://wamp.ws/)**:
**Autobahn**|Android is a subproject of the [Autobahn project](http://autobahn.ws/) and provides an open-source implementation

* **[The WebSocket Protocol](http://tools.ietf.org/html/rfc6455)**
* **[The Web Application Messaging Protocol (WAMP)](http://wamp.ws/)**

for Android.

WebSocket allows [bidirectional real-time messaging on the Web](http://tavendo.com/blog/post/websocket-why-what-can-i-use-it/).

WAMP provides asynchronous **Remote Procedure Calls** and **Publish & Subscribe** for applications in *one* protocol.

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

> Note: **Autobahn**|Android implements version 1 of WAMP. Current versions of the other Autobahn project libraries already provide implementations of version 2 of the protocol, with substantially expanded capabilities. An update to **Autobahn**|Android is under development.
## Features

* library for WebSocket and WAMP clients
* implements WebSocket RFC6455, Draft Hybi-10+ and WAMP v1
Expand All @@ -15,16 +29,15 @@ AutobahnAndroid implements **[The WebSocket Protocol](http://tools.ietf.org/html

You can use AutobahnAndroid to create native Android apps talking to WebSocket servers or any WAMP compatible server.

Using WAMP you can build applications around **asynchronous RPC and PubSub** messaging patterns.

## More Information

Where to go
-----------
For more information, take a look at the [project documentation](http://autobahn.ws/android). This provides:

For more information, including getting started, tutorials and reference documentation, please visit the project's [homepage](http://autobahn.ws/android), or check out the demos in this repository.
* [a quick 'Getting Started'](http://autobahn.ws/android/gettingstarted)
* [a list of all examples in this repo](http://autobahn.ws/android/examples)
* [a full API reference](http://autobahn.ws/python/reference)


Get in touch
------------
## Get in touch

Get in touch on IRC #autobahn on chat.freenode.net or join the [mailing list](http://groups.google.com/group/autobahnws).
4 changes: 3 additions & 1 deletion doc/_templates/side-secondary.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
<p class="logo">
<a href="{{ pathto(master_doc) }}"><img class="logo" src="{{ pathto('_static/logo.png', 1) }}" height="200" width="200" alt="Autobahn|Android"/></a>
<a href="/"><img class="logo" src="{{ pathto('_static/logo.png', 1) }}" height="200" width="200" alt="Autobahn|Android"/></a>
</p>

<h3><strong>Autobahn</strong>|Android</h3>

<p>
<iframe src="http://ghbtns.com/github-btn.html?user=tavendo&repo=AutobahnAndroid&type=watch&count=true&size=large"
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px">
Expand Down
8 changes: 8 additions & 0 deletions doc/_themes/kr/static/android.css
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
padding: 6px 6px 0;
position: relative;
width: 100%;
font-size: 1em;
}

dl.constructor,
Expand All @@ -36,3 +37,10 @@ dl.type {
dl.type > dd {
color: #3e4349;
}


.legacynotice {
border: 1px solid rgb(248, 139, 0);
background-color: #FFD1A0;
padding: 1em;
}
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,6 @@
rst_prolog = """
.. container:: topnav
:doc:`Overview </index>` :doc:`Getting Started </gettingstarted>` :doc:`/examples` :doc:`API Reference </_gen/packages>`
:doc:`Overview </index>` :doc:`Getting Started </gettingstarted>` :doc:`/examples` :doc:`API Reference </_gen/packages>` :doc:`/table_of_contents`
"""
7 changes: 6 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@

for creating native mobile WebSocket/WAMP clients.

WebSocket allows `bidirectional real-time messaging on the Web <http://tavendo.com/blog/post/websocket-why-what-can-i-use-it/>`_.

WAMP adds asynchronous **Remote Procedure Calls** and **Publish & Subscribe** for applications in *one* protocol.

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


WebSocket
---------
Expand Down Expand Up @@ -173,7 +179,6 @@ If you like, :doc:`get started <gettingstarted>`, check out the :doc:`examples`
:maxdepth: 2
:hidden:

index
gettingstarted
examples
_gen/packages
Expand Down

0 comments on commit eac7ead

Please sign in to comment.