README
¶
Scribe
Documentation
¶
Overview ¶
Copyright © 2020 Will Rowe <w.p.m.rowe@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
src
|
|
|
backend
Package backend interfaces with the Go IPFS API and enables pubsub for Scribe data.
|
Package backend interfaces with the Go IPFS API and enables pubsub for Scribe data. |
|
config
Package config is used to set up and manage the Scribe config file
|
Package config is used to set up and manage the Scribe config file |
|
helpers
Package helpers contains some useful helper functions for scribe
|
Package helpers contains some useful helper functions for scribe |
|
records
Package records interfaces the protobuf definitions with Scribe Package records interfaces the protobuf definitions with Scribe Package records interfaces the protobuf definitions with Scribe
|
Package records interfaces the protobuf definitions with Scribe Package records interfaces the protobuf definitions with Scribe Package records interfaces the protobuf definitions with Scribe |