Skip to content
This repository was archived by the owner on Apr 19, 2024. It is now read-only.

Commit f155754

Browse files
committed
add readme based on module docstring
1 parent 293fb1d commit f155754

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
======================================================
2+
Python implementation of the multihash specification
3+
======================================================
4+
5+
This is an implementation of the `multihash`_ specification in Python.
6+
The main component in the module is the `Multihash` class, a named tuple that
7+
represents a hash function and a digest created with it, with extended
8+
abilities to work with hashlib-compatible hash functions, verify the integrity
9+
of data, and encode itself to a byte string in the binary format described in
10+
the specification. The `decode()` function can be used for the inverse
11+
operation, i.e. converting a byte string into a `Multihash` object.
12+
13+
.. _multihash: https://github.com/jbenet/multihash
14+
15+
Please see the docstring in the ``multihash`` module for more information.

0 commit comments

Comments
 (0)