diff --git a/README.md b/README.md new file mode 100644 index 0000000..8f1b526 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# eventstore + +A collection of reusable database connectors, wrappers and schemas that store Nostr events and expose a simple Go interface: + +```go +type Store interface { + // Init is called at the very beginning by [Server.Start], after [Relay.Init], + // allowing a storage to initialize its internal resources. + Init() error + + // Close must be called after you're done using the store, to free up resources and so on. + Close() + + // QueryEvents is invoked upon a client's REQ as described in NIP-01. + // it should return a channel with the events as they're recovered from a database. + // the channel should be closed after the events are all delivered. + QueryEvents(context.Context, nostr.Filter) (chan *nostr.Event, error) + + // DeleteEvent is used to handle deletion events, as per NIP-09. + DeleteEvent(context.Context, *nostr.Event) error + + // SaveEvent is called once Relay.AcceptEvent reports true. + SaveEvent(context.Context, *nostr.Event) error +} +``` + +[![Go Reference](https://pkg.go.dev/badge/github.com/fiatjaf/eventstore.svg)](https://pkg.go.dev/github.com/fiatjaf/eventstore) + +## command-line tool + +There is an [`eventstore` command-line tool](cli) that can be used to query these databases directly.