diff --git a/README.md b/README.md deleted file mode 100644 index a213312..0000000 --- a/README.md +++ /dev/null @@ -1,33 +0,0 @@ -frozendict -========== - -`frozendict` is an immutable wrapper around dictionaries that implements the -complete mapping interface. It can be used as a drop-in replacement for -dictionaries where immutability is desired. - -Of course, this is `python`, and you can still poke around the object's -internals if you want. - -The `frozendict` constructor mimics `dict`, and all of the expected -interfaces (`iter`, `len`, `repr`, `hash`, `getitem`) are provided. -Note that a `frozendict` does not guarantee the immutability of its values, so -the utility of `hash` method is restricted by usage. - -The only difference is that the `copy()` method of `frozendict` takes -variable keyword arguments, which will be present as key/value pairs in the new, -immutable copy. - -Example shell usage: - - from frozendict import frozendict - - fd = frozendict({ 'hello': 'World' }) - - print fd - # - - print fd['hello'] - # 'World' - - print fd.copy(another='key/value') - # diff --git a/README.txt b/README.rst similarity index 95% rename from README.txt rename to README.rst index 133645e..133a0b1 100644 --- a/README.txt +++ b/README.rst @@ -18,7 +18,9 @@ The only difference is that the ``copy()`` method of ``frozendict`` takes variable keyword arguments, which will be present as key/value pairs in the new, immutable copy. -Example shell usage:: +Example shell usage: + +.. code-block:: python from frozendict import frozendict diff --git a/setup.py b/setup.py index 223d507..a006c08 100644 --- a/setup.py +++ b/setup.py @@ -1,4 +1,4 @@ -from distutils.core import setup +from setuptools import setup setup( name = 'frozendict', @@ -12,5 +12,5 @@ setup( license = 'MIT License', description = 'An immutable dictionary', - long_description = open('README.txt').read() + long_description = open('README.rst').read() )