Add a bit of basic documentation

courtesy of @frol. Closes #13
celery · Feb 17, 2021 · e881321 · e881321
1 parent 84f2587
commit e881321
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 4 deletions.
diff --git a/README.rst b/README.rst
@@ -7,12 +7,16 @@
 :Version: 5.0.0
 :Web: https://vine.readthedocs.io/
 :Download: https://pypi.org/project/vine/
-:Source: http://github.com/celery/vine/
+:Source: https://github.com/celery/vine/
 :Keywords: promise, async, future
 
 About
 =====
 
+This is a special implementation of promises in that it can be used both
+for promise of a value and lazy evaluation. The biggest upside for this
+is that everything in a promise can also be a promise, e.g. filters,
+callbacks and errbacks can all be promises.
 
 .. |build-status| image:: https://secure.travis-ci.org/celery/vine.png?branch=master
     :alt: Build status

diff --git a/docs/includes/introduction.txt b/docs/includes/introduction.txt
@@ -1,9 +1,13 @@
 :Version: 5.0.0
 :Web: https://vine.readthedocs.io/
 :Download: https://pypi.org/project/vine/
-:Source: http://github.com/celery/vine/
+:Source: https://github.com/celery/vine/
 :Keywords: promise, async, future
 
 About
 =====
 
+This is a special implementation of promises in that it can be used both
+for promise of a value and lazy evaluation. The biggest upside for this
+is that everything in a promise can also be a promise, e.g. filters,
+callbacks and errbacks can all be promises.
diff --git a/vine/__init__.py b/vine/__init__.py
@@ -1,4 +1,4 @@
-"""Promises, promises, promises."""
+"""Python promises"""
 import re
 
 from collections import namedtuple
@@ -15,7 +15,7 @@
 __version__ = '5.0.0'
 __author__ = 'Ask Solem'
 __contact__ = 'ask@celeryproject.org'
-__homepage__ = 'http://github.com/celery/vine'
+__homepage__ = 'https://github.com/celery/vine'
 __docformat__ = 'restructuredtext'
 
 # -eof meta-