Skip to content

Commit

Permalink
Some documentation that didn't make it into 0.0.3
Browse files Browse the repository at this point in the history
  • Loading branch information
rgs258 committed Jul 9, 2020
1 parent c97a272 commit f247465
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
Changelog
=========

0.0.4 (2020-07-09)
------------------
#. Some documentation that didn't make it into 0.0.3

0.0.3 (2020-07-09)
------------------
#. Correct a typo the README.rst
Expand Down
26 changes: 24 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
Django Markdown View
====================

.. image:: https://travis-ci.org/rgs258/django-markdown-view.svg?branch=master
:target: https://travis-ci.org/rgs258/django-markdown-view

.. image:: https://coveralls.io/repos/github/rgs258/django-markdown-view/badge.svg?branch=master
:target: https://coveralls.io/github/rgs258/django-markdown-view?branch=master


**Serve .md pages as Django views.**

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

.. note::
* This package needs tests, and to have Travis properly configured.
* This package needs tests, and to have Travis and Coveralls properly configured.

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

#. Serve the `MARKDOWN_VIEW_TEMPLATE` with the context variables
#. Serve the `MARKDOWN_VIEW_TEMPLATE` with the context variables


Contributing
------------

All contributions are very welcomed. Propositions, problems, bugs, and
enhancement are tracked with `GitHub issues`_ and patches are submitted
via `pull requests`_.

We use `Travis`_ coupled with `Coveralls`_ as continious integration tools.

.. _`GitHub issues`: https://github.com/rgs258/django-markdown-view/issues
.. _`pull requests`: https://github.com/rgs258/django-markdown-view/pulls
.. _Travis: https://travis-ci.org/github/rgs258/django-markdown-view
.. _Coveralls: https://coveralls.io/github/rgs258/django-markdown-view

0 comments on commit f247465

Please sign in to comment.