Replying to Avatar Silberengel

From 5f30980c15b9688cb41a9c487505c330699f04da Mon Sep 17 00:00:00 2001

From: Stella

Date: Thu, 6 Jun 2024 13:06:29 +0200

Subject: [PATCH] Updated ReadMe to reflect move to Nostr Wiki documentation. Edited relays in the maintainers file.

---

README.md | 17 +++++++----------

maintainers.yaml | 6 ++++++

2 files changed, 13 insertions(+), 10 deletions(-)

create mode 100644 maintainers.yaml

diff --git a/README.md b/README.md

index b2cd674..4daf1a8 100644

--- a/README.md

+++ b/README.md

@@ -2,16 +2,6 @@

A Nostr System Development Kit written in C++.

-## Behind the Name

-

-In the ancient Roman Republic, the aediles were officials elected from among the plebians and charged with caring for Rome's public infrastructure and ensuring an accurate system of weights and measures.

-

-The aim of the Aedile SDK is in the spirit of that ancient office:

-

-- Provide a fast and efficient service for interacting with Nostr relays via WebSocket connections.

-- Offer stable, well-tested implementations of commonly-used [Nostr Implementation Possibilities (NIPs)](https://github.com/nostr-protocol/nips/tree/master).

-- Open up Nostr development by taking care of the basics so developers can focus on solving problems, rather than reimplementing the protocol.

-

## Building the SDK

### Prerequisites

@@ -43,3 +33,10 @@ To run unit tests, use the following command:

```bash

ctest --preset linux

```

+

+## Project documentation

+

+The full project documentation is available at

+nostr:naddr1qvzqqqrcvgpzpprwhau6p2ypxf6we9e8fyrzrt2z8ut28er56l7kde4f30lyuwdyqythwumn8ghj7un9d3shjtnwdaehgu3wvfskuep0qq9xzetyd9kx2ttwv34sqllhrs

+

+which is viewable on [Wikifreedia](https://wikifreedia.xyz/aedile-ndk/npub1s3ht77dq4zqnya8vjun5jp3p44pr794ru36d0ltxu65chljw8xjqd975wz), [Nostrudel](https://next.nostrudel.ninja/#/wiki/topic/aedile-ndk), or [Wikistr](https://wikistr.com/aedile-ndk*846ebf79a0a8813274ec9727490621ad423f16a3e474d7fd66e6a98bfe4e39a4)

diff --git a/maintainers.yaml b/maintainers.yaml

new file mode 100644

index 0000000..0bac24e

--- /dev/null

+++ b/maintainers.yaml

@@ -0,0 +1,6 @@

+maintainers:

+- npub1wqfzz2p880wq0tumuae9lfwyhs8uz35xd0kr34zrvrwyh3kvrzuskcqsyn

+- npub1ecdlntvjzexlyfale2egzvvncc8tgqsaxkl5hw7xlgjv2cxs705s9qs735

+relays:

+- wss://theforest.nostr1.com

+- wss://thecitadel.nostr1.com

--

libgit2 1.7.2

I guess this is aimed more at nostr:npub1wqfzz2p880wq0tumuae9lfwyhs8uz35xd0kr34zrvrwyh3kvrzuskcqsyn

Reply to this note

Please Login to reply.

Discussion

No replies yet.