Skip to content

Commit baff90e

Browse files
committed
update readme
1 parent 44274e8 commit baff90e

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
*.egg-info/
33
build/
44
dist/
5+
MANIFEST.in
56

67
# Virtual environment
78
venv/

README.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,27 @@
1-
## Riemann: Multi-coin transaction generation toolbox.
1+
## Riemann: bitcoin transactions for humans
22

33
[![Build Status](https://travis-ci.org/summa-tx/riemann.svg?branch=master)](https://travis-ci.org/summa-tx/riemann)
44
[![Coverage Status](https://coveralls.io/repos/github/summa-tx/riemann/badge.svg)](https://coveralls.io/github/summa-tx/riemann)
55

6-
7-
### Contributing
8-
9-
Please read CONTRIBUTING.md.
10-
116
### Purpose
127

13-
Riemann is a **dependency-free Python3** library for creating **bitcoin-style transactions**. It is compatible with many chains and **supports SegWit**.
8+
Riemann is a **dependency-free Python3** library for creating **bitcoin-style transactions**. It is **compatible with many chains** and **supports SegWit**.
149

1510
Riemann aims to make it easy to create application-specific transactions. It serializes and unserializes scripts from human-readable strings. It contains a complete toolbox for transaction construction, as well as built-in support for ~20 live networks and ~40 testnet or regtest nets.
1611

1712
Riemann is NOT a wallet. It does NOT handle keys or create signatures. Riemann is NOT a protocol or RPC implementation. Riemann does NOT communicate with anything. Ever. Riemann is NOT a Script VM. Riemann does NOT check the validity of your scriptsigs.
1813

1914
Riemann is _almost_ stateless. Before calling functions, you select a network. A list of supported networks is in `riemann/networks/__init__.py`. **No networks have been thoroughly tested.**
2015

16+
### Contributing
17+
18+
Please read CONTRIBUTING.md.
19+
2120
### Installation, Development & Running Tests
2221

2322
```
24-
$ git clone $LIB_URL
25-
$ cd riemann-tx
23+
$ git clone [email protected]:summa-tx/riemann.git
24+
$ cd riemann
2625
$ virtualenv -p python3 venv
2726
$ source venv/bin/activate
2827
$ pip install -r requirements-test.txt

0 commit comments

Comments
 (0)