mirror of https://github.com/carlostrub/sisyphus
more documentation
parent
ca521d51d6
commit
e24bd2b7ff
@ -1,41 +1,41 @@
|
|||||||
Sisyphus
|
Sisyphus
|
||||||
========
|
========
|
||||||
|
|
||||||
$project will solve your problem of where to start with documentation,
|
Sisyphus is a modern, fully automized junk mail handler. It requires no
|
||||||
by providing a basic explanation of how to do it easily.
|
configuration and no user interaction to improve the accuracy of its learning
|
||||||
|
algorithm.
|
||||||
Look how easy it is to use:
|
|
||||||
|
|
||||||
import project
|
|
||||||
# Get your stuff done
|
|
||||||
project.do_stuff()
|
|
||||||
|
|
||||||
Features
|
Features
|
||||||
--------
|
--------
|
||||||
|
|
||||||
- Be awesome
|
- no configuration required
|
||||||
- Make things faster
|
- no user interaction
|
||||||
|
- real-time filtering and learning
|
||||||
|
- handles multiple mail directories
|
||||||
|
- compatible with Maildir
|
||||||
|
- daemonized
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
------------
|
------------
|
||||||
|
|
||||||
Install $project by running:
|
Install sisyphus by running:
|
||||||
|
|
||||||
install project
|
install project
|
||||||
|
|
||||||
Contribute
|
Contribute
|
||||||
----------
|
----------
|
||||||
|
|
||||||
- Issue Tracker: github.com/$project/$project/issues
|
- Issue Tracker: github.com/carlostrub/sisyphus/issus
|
||||||
- Source Code: github.com/$project/$project
|
- Source Code: github.com/carlostrub/sisyphus
|
||||||
|
|
||||||
Support
|
Support
|
||||||
-------
|
-------
|
||||||
|
|
||||||
If you are having issues, please let us know.
|
If you are having issues, please let me know via issue tracker.
|
||||||
We have a mailing list located at: project@google-groups.com
|
|
||||||
|
|
||||||
License
|
License
|
||||||
-------
|
-------
|
||||||
|
Copyright 2017, Carlo Strub <cs@carlostrub.ch>
|
||||||
|
|
||||||
The project is licensed under the BSD license.
|
This project is licensed under a 3-clause BSD license. See the LICENSE file for
|
||||||
|
details.
|
||||||
|
Loading…
Reference in New Issue