From 8daa19e9a2ac7d3c69da10bfcd2c469bd07e6433 Mon Sep 17 00:00:00 2001 From: Byron H Date: Wed, 19 Jul 2023 16:52:30 -0500 Subject: [PATCH] Add readme and license. --- LICENSE | 21 +++++++++++++++++++++ README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 66 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ddf770 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 SimCoder + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..fa04d05 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# Likzap + +A nostr bot to zap a note when you like it. + +## Getting Started + +Clone repository: + +```bash +git clone https://github.com/silencesoft/likzap.git +cd likzap +cp .env.sample .env +``` + +With docker: + +```bash +docker-compose build +docker-compose up -d +``` + +Local test and deployment: + +```bash +yarn +yarn dev +``` + +Modify the environment variables file: + +- USER_PUBLIC_KEY : Your npub key +- USER_SECRET_KEY : Your hex secret key +- NOSTR_RELAYS : A list of relays comma separated +- LNDHUB_URL : LNDHub server +- ZAP_VALUE : Zap amount + +* There is a known bug with yarn build in nostr-relaypool library + +## Thanks + +Support: [npub1djxd9fd495r2llyjsx4aed0elcgy8fndw0pxx80pl0tuaa3kkuhq6r9mgy](nostr:npub1djxd9fd495r2llyjsx4aed0elcgy8fndw0pxx80pl0tuaa3kkuhq6r9mgy) + +My Nostr Public key: [npub1gcmpunjrue2aq5um7qgnp4p6uxarlxw2z6djehaf0emxjf6gr9us548zdf](nostr:npub1gcmpunjrue2aq5um7qgnp4p6uxarlxw2z6djehaf0emxjf6gr9us548zdf) + +Buy me a coffee (with satoshis): [https://lncoffee.me/silencesoft](https://lncoffee.me/silencesoft)