Skip to content

Commit

Permalink
minor improvemens to README and setup.py
Browse files Browse the repository at this point in the history
  • Loading branch information
pablohoffman committed Apr 25, 2014
1 parent 4d37c7d commit 9691f33
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 8 deletions.
25 changes: 18 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,24 @@
Splash - A javascript rendering service
=======================================

Introduction
============
Splash is a javascript rendering service with an HTTP API. It's a lightweight
browser with an HTTP API, implemented in Python using Twisted and QT.

Splash is a javascript rendering service with a HTTP API. It runs on top of
twisted and QT webkit for rendering pages.
It's fast, lightweight and state-less which makes it easy to distribute.

The (twisted) QT reactor is used to make the sever fully asynchronous allowing
to take advantage of webkit concurrency via QT main loop.
Documentation
-------------

See documentation in ``docs/index.rst``
Documentation is available here:
http://splash.readthedocs.org/

Support
-------

Open source support is provided here in Github. Please `create a question
issue`_ (ie. issue with "question" label).

Commercial support is also available by `Scrapinghub`_.

.. _create a question issue: https://github.com/scrapinghub/splash/issues/new?labels=question
.. _Scrapinghub: http://scrapinghub.com
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
'packages': ['splash'],
'url': 'https://github.com/scrapinghub/splash',
'description': 'A javascript rendered with a HTTP API',
'long_description': open('docs/index.rst').read(),
'long_description': open('README.rst').read(),
'author': 'Scrapinghub',
'author_email': '[email protected]',
'maintainer': 'Scrapinghub',
'maintainer_email': '[email protected]',
'license': 'BSD',
Expand Down

0 comments on commit 9691f33

Please sign in to comment.