Skip to content

Commit f247465

Browse files
committed
Some documentation that didn't make it into 0.0.3
1 parent c97a272 commit f247465

File tree

2 files changed

+28
-2
lines changed

2 files changed

+28
-2
lines changed

CHANGELOG.rst

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
Changelog
22
=========
33

4+
0.0.4 (2020-07-09)
5+
------------------
6+
#. Some documentation that didn't make it into 0.0.3
7+
48
0.0.3 (2020-07-09)
59
------------------
610
#. Correct a typo the README.rst

README.rst

+24-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
Django Markdown View
22
====================
33

4+
.. image:: https://travis-ci.org/rgs258/django-markdown-view.svg?branch=master
5+
:target: https://travis-ci.org/rgs258/django-markdown-view
6+
7+
.. image:: https://coveralls.io/repos/github/rgs258/django-markdown-view/badge.svg?branch=master
8+
:target: https://coveralls.io/github/rgs258/django-markdown-view?branch=master
9+
10+
411
**Serve .md pages as Django views.**
512

613
This package aims to make it easy to serve .md files on Django sites.
@@ -10,7 +17,7 @@ This package aims to make it easy to serve .md files on Django sites.
1017
:depth: 5
1118

1219
.. note::
13-
* This package needs tests, and to have Travis properly configured.
20+
* This package needs tests, and to have Travis and Coveralls properly configured.
1421

1522
Requirements
1623
------------
@@ -181,4 +188,19 @@ At a high level, `MarkdownView` will:
181188
#. Render as a template, the contents of the .md file prepended with
182189
`{{% load static %}}`, into several context variables
183190

184-
#. Serve the `MARKDOWN_VIEW_TEMPLATE` with the context variables
191+
#. Serve the `MARKDOWN_VIEW_TEMPLATE` with the context variables
192+
193+
194+
Contributing
195+
------------
196+
197+
All contributions are very welcomed. Propositions, problems, bugs, and
198+
enhancement are tracked with `GitHub issues`_ and patches are submitted
199+
via `pull requests`_.
200+
201+
We use `Travis`_ coupled with `Coveralls`_ as continious integration tools.
202+
203+
.. _`GitHub issues`: https://github.com/rgs258/django-markdown-view/issues
204+
.. _`pull requests`: https://github.com/rgs258/django-markdown-view/pulls
205+
.. _Travis: https://travis-ci.org/github/rgs258/django-markdown-view
206+
.. _Coveralls: https://coveralls.io/github/rgs258/django-markdown-view

0 commit comments

Comments
 (0)