Skip to content

Commit

Permalink
Updated README.rst
Browse files Browse the repository at this point in the history
Added build status,  coverage and code climate badges; added mention of semantic versioning.
  • Loading branch information
agronholm committed Sep 8, 2015
1 parent 815609a commit 596015c
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,29 @@
.. image:: https://travis-ci.org/asphalt-framework/asphalt.svg?branch=master
:target: https://travis-ci.org/asphalt-framework/asphalt
:alt: Build Status
.. image:: https://coveralls.io/repos/asphalt-framework/asphalt/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/asphalt-framework/asphalt?branch=master
:alt: Code Coverage
.. image:: https://codeclimate.com/github/asphalt-framework/asphalt/badges/gpa.svg
:target: https://codeclimate.com/github/asphalt-framework/asphalt
:alt: Code Climate

Asphalt is a microframework for service oriented applications.

It consists of the core (this) and an ecosystem of high level components that offer additional
functionality, often by integrating third party libraries. Asphalt is unique in that it allows
developers to use both coroutine-based (asynchronous) and traditional blocking programming styles
in the same application and every API provided by any Asphalt component supports both approaches,
nearly transparently to the developer.
nearly transparently to the developer. The whole Asphalt ecosystem also follows
`semantic versioning`_, allowing for safe upgrades.

Asphalt is based on the standard library `asyncio`_ module and requires Python 3.4 or later.
Asphalt uses the standard library `asyncio`_ module and requires Python 3.4 or later.

The list of `available components`_ is on the Asphalt wiki.


Important links
---------------
Project links
-------------

* `Documentation`_
* `Source code`_
Expand All @@ -25,6 +36,7 @@ Support
* `Freenode IRC`_: #asphalt
* `StackOverflow`_: Tag your questions with ``asphalt``

.. _semantic versioning: http://semver.org/
.. _asyncio: https://docs.python.org/3/library/asyncio.html
.. _available components: https://github.com/asphalt-framework/asphalt/wiki/Components
.. _Documentation: http://asphalt.readthedocs.org/en/latest/
Expand Down

0 comments on commit 596015c

Please sign in to comment.