Skip to content

Commit 90d9837

Browse files
fixed readme and docs
1 parent 87af072 commit 90d9837

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Sifter3 - Sieve email filter (RFC 5228)
22

3-
Sifter3 is a Python 3 implementation of the Sieve email filter language (RFC 5228) and is based on the Python 2 version from <https://github.com/garyp/sifter>
3+
Sifter3 is a Python 3 implementation of the Sieve email filter language (RFC 5228)
44

55
![Python package](https://github.com/manfred-kaiser/sifter3/workflows/Python%20package/badge.svg)
6-
[![Documentation Status](https://readthedocs.org/projects/sifter3/badge/?version=master)](https://sifter3.readthedocs.io/de/master/?badge=master)
6+
[![Documentation Status](https://readthedocs.org/projects/sifter3/badge/?version=latest)](https://sifter3.readthedocs.io/en/latest/?badge=latest)
77
[![CodeFactor](https://www.codefactor.io/repository/github/manfred-kaiser/sifter3/badge)](https://www.codefactor.io/repository/github/manfred-kaiser/sifter3)
88
[![Github version](https://img.shields.io/github/v/release/manfred-kaiser/sifter3?label=github&logo=github)](https://github.com/manfred-kaiser/sifter3/releases)
99
[![PyPI version](https://img.shields.io/pypi/v/sifter3.svg?logo=pypi&logoColor=FFE873)](https://pypi.org/project/sifter3/)
@@ -45,6 +45,13 @@ email message. Each action is a tuple consisting of the action name and
4545
action-specific arguments. It is up to the caller to manipulate the
4646
message and message store based on the actions returned.
4747

48+
COMMAND LINE
49+
============
50+
51+
$ sifter tests/evaluation_1.rules tests/evaluation_1.msg
52+
[('redirect', '[email protected]')]
53+
54+
4855
WARNINGS
4956
========
5057

docs/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,15 @@ consisting of the action name and action-specific arguments. It is up to
4545
the caller to manipulate the message and message store based on the
4646
actions returned.
4747

48+
COMMAND LINE
49+
------------
50+
51+
.. code-block:: bash
52+
53+
$ sifter tests/evaluation_1.rules tests/evaluation_1.msg
54+
[('redirect', '[email protected]')]
55+
56+
4857
WARNINGS
4958
--------
5059

0 commit comments

Comments
 (0)