Commit ae0e04f4 authored by chrissi^'s avatar chrissi^
Browse files

Update README.md

parent b737db60
......@@ -10,15 +10,21 @@ in Markdow files!)
The following elements of the recipe are exposed in the
content-object:
* title
* tags
* ``title``
* ``tags``
Everything else can be accessed using the content['recipe']
Everything else can be accessed using the ``content['recipe']``
attribute.
## How to use
First add it to your flaming plugin-list:
First add this plugin to your ``REQUIREMENTS.txt`` by adding
the following line:
```
git+https://gitli.stratum0.org/chrissi/flamingo-recipemd.git#egg=flamingo-recipemd
```
Then add it to your flaming plugin-list:
```
PLUGINS = [
......@@ -28,9 +34,19 @@ PLUGINS = [
]
```
If you want to add extra tags to all recipes add the following
to your settings:
## Settings
``flamingo-recipemd`` can be configured with the following options:
### Extra Tags
You can add extra tags to every recipie with the ``RECIPEMD_EXTRA_TAGS``
option:
```
RECIPEMD_EXTRA_TAGS = ['Essen']
```
## TODO
* [ ] Create a pypi-package for this project
* [ ] Do proper releases
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment