Codebase list python-repoze.tm2 / 16cede7
Garden / modernize README. - Add sections on installation, usage, bug reporting, and source checkouts. [ci skip] Tres Seaver 7 years ago
1 changed file(s) with 38 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
+38
-0
README.rst less more
1717 its pipeline children inside a transaction. This is a fork of the
1818 ``repoze.tm`` package which depends only on the ``transaction``
1919 package rather than the entirety of ZODB (for users who don't rely on ZODB).
20
21 Installation
22 ------------
23
24 Install using setuptools, e.g. (within a virtualenv)::
25
26 $ easy_install repoze.tm2
27
28 or using pip::
29
30 $ pip install repoze.tm2
31
32
33 Usage
34 -----
35
36 For details on using the various components, please see the
37 documentation in ``docs/index.rst``. A rendered version of that documentation
38 is also available online:
39
40 - http://repozetm2.readthedocs.org/en/latest/
41
42
43 Reporting Bugs
44 --------------
45
46 Please report bugs in this package to
47
48 https://github.com/repoze/repoze.tm2/issues
49
50
51 Obtaining Source Code
52 ---------------------
53
54 Download development or tagged versions of the software by visiting:
55
56 https://github.com/repoze/repoze.tm2
57