From 85e5644e2f0460fdf3207f88a74946611f3556fd Mon Sep 17 00:00:00 2001 From: fiatjaf Date: Sun, 2 Jan 2022 17:30:35 -0300 Subject: [PATCH] add some readmes. --- LICENSE | 24 ++++++++++++++++++++++++ README.md | 4 ++++ basic/README | 24 ++++++++++++++++++++++++ 3 files changed, 52 insertions(+) create mode 100644 LICENSE create mode 100644 basic/README diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..fdddb29 --- /dev/null +++ b/LICENSE @@ -0,0 +1,24 @@ +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or +distribute this software, either in source code form or as a compiled +binary, for any purpose, commercial or non-commercial, and by any +means. + +In jurisdictions that recognize copyright laws, the author or authors +of this software dedicate any and all copyright interest in the +software to the public domain. We make this dedication for the benefit +of the public at large and to the detriment of our heirs and +successors. We intend this dedication to be an overt act of +relinquishment in perpetuity of all present and future rights to this +software under copyright law. + +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 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. + +For more information, please refer to diff --git a/README.md b/README.md index b0d7533..b4d1c4c 100644 --- a/README.md +++ b/README.md @@ -1 +1,5 @@ Nostr Relay Framework -- use it to implement your own custom relay. + +There is an example/reference implementation at [basic](basic/). Binaries for that are also available under [Releases](releases/). + +GoDoc diff --git a/basic/README b/basic/README new file mode 100644 index 0000000..8b50236 --- /dev/null +++ b/basic/README @@ -0,0 +1,24 @@ +basic relayer +============= + + - a basic relay implementation based on relayer. + - uses postgres, which I think must be over version 12 since it uses generated columns. + - it has some antispam limits, tries to delete old stuff so things don't get out of control, and some other small optimizations, but it's something we can call "hardened". + +running +------- + +grab a binary from the releases page and run it with the environment variable POSTGRESQL_DATABASE set to some postgres url: + + POSTGRESQL_DATABASE=postgres://name:pass@localhost:5432/dbname ./relayer + +it also accepts a HOST and a PORT environment variables. + +compiling +--------- + +if you know Go you already know this: + + go get github.com/fiatjaf/relayer/basic + +or something like that.