update readme

This commit is contained in:
Jack Robison 2022-03-08 20:30:00 -05:00
parent 0652be4535
commit cd72c8b080
No known key found for this signature in database
GPG key ID: DF25C68FE0239BB2

View file

@ -1,12 +1,12 @@
Scribe maintains a rocksdb database containing the [LBRY blockchain](https://github.com/lbryio/lbrycrd) and provides an interface for python based services that utilize the blockchain data in an ongoing manner. Scribe includes implementations of this interface to provide an electrum server for thin-wallet clients such as lbry-sdk and to maintain an elasticsearch database of claims in the LBRY blockchain.
Scribe maintains a rocksdb database containing the [LBRY blockchain](https://github.com/lbryio/lbrycrd) and provides an interface for python based services that utilize the blockchain data in an ongoing manner. Scribe includes implementations of this interface to provide an electrum server for thin-wallet clients (such as lbry-sdk) and to maintain an elasticsearch database of metadata for claims in the LBRY blockchain.
* Uses Python 3.7-3.8
* Protobuf schema for encoding and decoding metadata stored on the blockchain ([scribe.schema](https://github.com/lbryio/scribe/tree/master/scribe/schema)).
* Blockchain processor that maintains an up to date rocksdb database ([scribe.blockchain](https://github.com/lbryio/scribe/tree/master/scribe/blockchain))
* Rocksdb based database containing the blockchain data ([scribe.db](https://github.com/lbryio/scribe/tree/master/scribe/db))
* Interface for python services to implement in order for them maintain a read only view of the blockchain data ([scribe.readers.interface](https://github.com/lbryio/scribe/tree/master/scribe/db))
* Electrum based server for thin-wallet clients like lbry-sdk ([scribe.readers.hub_server](https://github.com/lbryio/scribe/tree/master/scribe/db))
* Elasticsearch sync utility to index all the claim metadata in the blockchain into an easily searchable form ([scribe.readers.elastic_sync](https://github.com/lbryio/scribe/tree/master/scribe/db))
* Interface for python services to implement in order for them maintain a read only view of the blockchain data ([scribe.readers.interface](https://github.com/lbryio/scribe/tree/master/scribe/readers/interface.py))
* Electrum based server for thin-wallet clients like lbry-sdk ([scribe.readers.hub_server](https://github.com/lbryio/scribe/tree/master/scribe/readers/hub_server.py))
* Elasticsearch sync utility to index all the claim metadata in the blockchain into an easily searchable form ([scribe.readers.elastic_sync](https://github.com/lbryio/scribe/tree/master/scribe/readers/elastic_sync.py))
## Installation