chore: update logo and readme

dezh-tech · Aug 30, 2024 · 3259ea1 · 3259ea1
1 parent bfc4877
commit 3259ea1
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 146 deletions.
diff --git a/README.md b/README.md
@@ -1,146 +1,5 @@
-# Nostr Relay NestJS
+# ENR 01
 
-[![Coverage Status](https://coveralls.io/repos/github/CodyTseng/nostr-relay-nestjs/badge.svg?branch=master)](https://coveralls.io/github/CodyTseng/nostr-relay-nestjs?branch=master)
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FCodyTseng%2Fnostr-relay-nestjs.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FCodyTseng%2Fnostr-relay-nestjs?ref=badge_shield)
+The enr-01 is a fork of [nostr-relay-nestjs](https://github.com/CodyTseng/nostr-relay-nestjs). This relay is updated and developed by Dezh Technologies to be used in [JellyFish](https://jellyfish.land) paid relay services till custom relay implementation release!
 
-Powered by [nostr-relay](https://github.com/CodyTseng/nostr-relay) & [NestJS](https://nestjs.com/).
-
-A high-performance nostr relay, using PostgreSQL.
-
-If you'd like to help me test the reliability of this relay implementation, you can add wss://nostr-relay.app to your relay list (it's free) 💜⚡️
-
-> **Note:** Please use the released version of this code. The latest version may contain changes to migration scripts and other elements that are not finalized.
-
-[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/ooFSnW?referralCode=WYIfFr)
-
-## Features
-
-🟢 Full implemented 🟡 Partially implemented 🔴 Not implemented
-
-| Feature                                                                                                 | Status | Note                                     |
-| ------------------------------------------------------------------------------------------------------- | :----: | ---------------------------------------- |
-| [NIP-01: Basic protocol flow description](https://github.com/nostr-protocol/nips/blob/master/01.md)     |   🟢   |                                          |
-| [NIP-02: Contact List and Petnames](https://github.com/nostr-protocol/nips/blob/master/02.md)           |   🟢   |                                          |
-| [NIP-04: Encrypted Direct Message](https://github.com/nostr-protocol/nips/blob/master/04.md)            |   🟢   |                                          |
-| [NIP-09: Event Deletion](https://github.com/nostr-protocol/nips/blob/master/09.md)                      |   🔴   | No real deletion in a distributed system |
-| [NIP-11: Relay Information Document](https://github.com/nostr-protocol/nips/blob/master/11.md)          |   🟢   |                                          |
-| [NIP-13: Proof of Work](https://github.com/nostr-protocol/nips/blob/master/13.md)                       |   🟢   |                                          |
-| [NIP-22: Event created_at Limits](https://github.com/nostr-protocol/nips/blob/master/22.md)             |   🟢   |                                          |
-| [NIP-26: Delegated Event Signing](https://github.com/nostr-protocol/nips/blob/master/26.md)             |   🟢   |                                          |
-| [NIP-28: Public Chat](https://github.com/nostr-protocol/nips/blob/master/28.md)                         |   🟢   |                                          |
-| [NIP-40: Expiration Timestamp](https://github.com/nostr-protocol/nips/blob/master/40.md)                |   🟢   |                                          |
-| [NIP-42: Authentication of clients to relays](https://github.com/nostr-protocol/nips/blob/master/42.md) |   🟢   |                                          |
-| [NIP-45: Counting results](https://github.com/nostr-protocol/nips/blob/master/45.md)                    |   🔴   |                                          |
-| [NIP-50: Keywords filter](https://github.com/nostr-protocol/nips/blob/master/50.md)                     |   🟢   |                                          |
-
-## Extra Features
-
-### RESTful API
-
-You can see the API documentation at `/api` endpoint.
-
-### TOP verb
-
-TOP verb accepts a subscription id and filters as specified in [NIP 01](https://github.com/nostr-protocol/nips/blob/master/01.md) for the verb REQ.
-
-```json
-["TOP",<subscription_id>,<filters JSON>...]
-```
-
-And return the top N event IDs with the highest score (Scoring is determined by relay).
-
-```json
-["TOP",<subscription_id>,<event id array>]
-```
-
-Example:
-
-```json
-["TOP","test",{"search":"nostr bitcoin","kinds":[30023],"limit":10}]
-
-["TOP","test",["2359f4bdfe0bd2353aa7702dc1af23279197694823b8b4916b904a9940334192","622a875c9f9a4696eb4050fa5b0bba3a9b0531ec4a27398245af7369e6d40da8","d8989c65d26511b2e3ea42b0ebfcaf0ea885cb958419df4ddb334cb72556f950","ffcb0c9e0ace0b5d3928f30395bc9832763f8b583f2b1beb696f7c199f9f94d2","287147867bd00299553fa91e110d40206eea19a9142a4283832ee67e1407e6f2","ffaea8bc3b08db32af97f1ff595e68eee8a2f7b0a4a66dc2eff330f450855f6c","cddbc6cd4a0589d4a593e99a3a94426c85c6867b47d7eb751ce419c27f079b76","f2291ac6d206e898965b9e4ba6bbe5bb10118e6a74bd9f9f13597813979a254b","a101a2a44938dbb0a611bc00bd7ed4cb44d682fea4c14618bd1148567cd6fcc3","21990a723b491b6c594438a2ecf5d5e4898212635f59e82f1c736d994a86e907"]]
-```
-
-## Quick Start
-
-### Dockerfile
-
-Build image
-
-```bash
-./scripts/build.sh
-```
-
-Create `.env` file based on [example.env](./example.env) file
-
-```.env
-DATABASE_URL=postgresql://username:password@host:port/database
-```
-
-Run container
-
-```bash
-./scripts/run.sh
-```
-
-### Local Development
-
-First of all, you need to have a PostgreSQL database running.
-
-Clone the repository and install dependencies
-
-```bash
-git clone https://github.com/CodyTseng/nostr-relay-nestjs.git
-cd nostr-relay-nestjs
-npm install
-```
-
-Create `.env` file based on [example.env](./example.env) file
-
-```.env
-DATABASE_URL=postgresql://username:password@host:port/database
-```
-
-Execute migration scripts
-
-```bash
-npm run migration:run
-```
-
-Start the server
-
-```bash
-npm run start
-```
-
-## Metrics
-
-You can view some simple relay metrics on `/metrics` endpoint.
-
-<img alt="Metrics snapshot" src="https://github.com/CodyTseng/resources/raw/master/nostr-relay-nestjs/img/metrics-snapshot.png" width="520">
-
-## TODO
-
-- [x] Unit test
-- [x] RESTful API
-- [ ] Metrics, Monitoring and Alerting
-- [ ] Support multi nodes
-- [ ] Support for Bitcoin Lightning Network payments
-
-## Architecture
-
-<picture>
-  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/CodyTseng/resources/raw/master/nostr-relay-nestjs/img/structure-dark.png">
-  <source media="(prefers-color-scheme: light)" srcset="https://github.com/CodyTseng/resources/raw/master/nostr-relay-nestjs/img/structure-light.png">
-  <img alt="Architecture Diagram" src="https://github.com/CodyTseng/resources/raw/master/nostr-relay-nestjs/img/structure-light.png" height="600">
-</picture>
-
-## Donate
-
-If you like this project, you can buy me a coffee :) ⚡️ codytseng@getalby.com ⚡️
-
-## License
-
-This project is MIT licensed.
-
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FCodyTseng%2Fnostr-relay-nestjs.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FCodyTseng%2Fnostr-relay-nestjs?ref=badge_large)
+You can join the jellyfish relay using jelly fish website at the moment.
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "enr-1",
   "version": "2.1.1",
-  "description": "The JellyFish-Dezh temp relay",
+  "description": "The JellyFish relay",
   "author": "codytseng",
   "private": true,
   "license": "MIT",

diff --git a/resources/jellyfish.jpg b/resources/jellyfish.jpg
diff --git a/src/main.ts b/src/main.ts
@@ -34,7 +34,7 @@ async function bootstrap() {
     next();
   });
 
-  app.use('/favicon.ico', ExpressStatic('./resources/favicon.ico'));
+  app.use('/jellyfish.jpg', ExpressStatic('./resources/jellyfish.jpg'));
 
   const express: Express = app.getHttpAdapter().getInstance();
   express.disable('x-powered-by');