Skip to content
This repository has been archived by the owner on Nov 3, 2022. It is now read-only.

Improve README & documentation #57

Merged
merged 1 commit into from
Jun 18, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 10 additions & 36 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,16 @@ kawasemi
:alt: Kawasemi's logo

**kawasemi** is a Python library for sending notifications.
HipChat, Slack, Twitter and Yo are supported for now.

kawasemi can be used easily in your Python projects.
kawasemi also provides integration with web application frameworks which makes it
more easier to load configurations.
Kawasemi provides the following features:

* Very simple ways to send notification

* HipChat, Slack, Twitter, and Yo are supported

* Integrations with web application frameworks helps to load configurations

* Django is supported

Note: This project was named *django-channels*.
We renamed our project not to be confused with the official `Django Channels`_.
Expand All @@ -47,43 +52,12 @@ Slack, Twitter, or Yo with a following simple code:
kawasemi = Kawasemi(config)
kawasemi.send("Sample notification.")
# With Django
# In Django application
from kawasemi.django import send
send("Sample notification.")
See `Quickstart`_ page for more details.

Requirements
------------

Python
^^^^^^
* Python 2.7+
* Python 3.3+
* PyPy
* PyPy3

Supported Frameworks
^^^^^^^^^^^^^^^^^^^^
* Django 1.8
* Django 1.9
* Django 1.10
* Django 1.11

Installation
------------

.. code-block:: shell
pip install kawasemi
Note: Please use the latest version of setuptools, pip, and wheel.

.. code-block:: shell
pip install -U setuptools pip wheel
Links
-----
* `Documentation`_
Expand Down
33 changes: 12 additions & 21 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,16 @@ kawasemi
:alt: Kawasemi's logo

**kawasemi** is a Python library for sending notifications.
HipChat, Slack, Twitter and Yo are supported for now.

kawasemi can be used easily in your Python projects.
kawasemi also provides integration with web application frameworks which makes it
more easier to load configurations.
Kawasemi provides the following features:

* Very simple ways to send notification

* HipChat, Slack, Twitter, and Yo are supported

* Integrations with web application frameworks helps to load configurations

* Django is supported

At a Glance
-----------
Expand All @@ -23,26 +28,11 @@ Slack, Twitter, or Yo with a following simple code:
kawasemi = Kawasemi(config)
kawasemi.send("Sample notification.")
# With Django
# In Django application
from kawasemi.django import send
send("Sample notification.")
Requirements
------------

Python
^^^^^^
* Python 2.7+
* Python 3.3+
* PyPy
* PyPy3

Supported Frameworks
^^^^^^^^^^^^^^^^^^^^
* Django 1.8
* Django 1.9
* Django 1.10
* Django 1.11
See `Quickstart`_ page for more details.

Contents
--------
Expand All @@ -67,3 +57,4 @@ Links

.. _Documentation: https://kawasemi.readthedocs.io/
.. _GitHub: https://github.com/ymyzk/kawasemi
.. _Quickstart: https://kawasemi.readthedocs.io/en/latest/quickstart.html
23 changes: 23 additions & 0 deletions docs/source/quickstart.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
Quickstart
==========

Requirements
------------

Python
^^^^^^
* Python 2.7+
* Python 3.3+
* PyPy
* PyPy3

Supported Frameworks
^^^^^^^^^^^^^^^^^^^^
* Django 1.8
* Django 1.9
* Django 1.10
* Django 1.11

Installation
------------
Install kawasemi with your favorite package manager:
Expand All @@ -9,6 +26,12 @@ Install kawasemi with your favorite package manager:
pip install kawasemi
Note: Please use the latest version of setuptools, pip, and wheel.

.. code-block:: shell
pip install -U setuptools pip wheel
Configurations
--------------
You can write the configuration of kawasemi with a dictionary object.
Expand Down