From cc53c3d5b5d5c21065b3f8a189568906aec85e55 Mon Sep 17 00:00:00 2001 From: hasundue Date: Tue, 3 Oct 2023 08:47:52 +0900 Subject: [PATCH] docs(readme): polish intro and features --- README.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a6ecc82..b6580c1 100644 --- a/README.md +++ b/README.md @@ -6,29 +6,21 @@ [![CI](https://github.com/hasundue/lophus/actions/workflows/ci.yml/badge.svg)](https://github.com/hasundue/lophus/actions/workflows/ci.yml) [![codecov](https://codecov.io/github/hasundue/lophus/branch/main/graph/badge.svg?token=s01IMg4nI8)](https://codecov.io/github/hasundue/lophus) -Yet another TypeScript library for [Nostr][nostr]. It showcases how seamlessly -the [Web Streams API][streams-api] integrates with the protocol. - -[nostr]: https://nostr.com -[streams-api]: https://developer.mozilla.org/docs/Web/API/Streams_API +Yet another TypeScript library for [Nostr][nostr], oriented to web standards and edge environments. ## Features - **Declarative** 🌊 - Lets you focus on the data flow rather than underlying logic. -- **Portable** ðŸ“Ķ - The client core (client.ts) has no dependencies on Deno or - Node.js APIs. +- **Portable** ðŸ“Ķ - The core modules have no dependencies on runtime APIs. - **Lightweight** ðŸŠķ - The minified version of client core (client.min.js) is - about 4.5 KB. + about 5 KB. - **Modular** 🔌 - High-level interfaces and NIPs are implemented as [optional modules][modules], which enables you to keep an app as small as possible. - **Compatible** ðŸĪ - Shares the same data structure for events as [nostr-tools][nostr-tools]. -[modules]: https://github.com/hasundue/lophus/tree/main/lib -[nostr-tools]: https://github.com/nbd-wtf/nostr-tools - ## Documentation - [API Reference](https://deno.land/x/lophus) (WIP) @@ -48,5 +40,10 @@ Development of Lophus is inspired by the following projects: - [nostring][nostring] - A Nostr relay library written in Deno - [Hono][hono] - A fast, lightweight, and multi-platform Web framework for edges + +[nostr]: https://nostr.com +[streams-api]: https://developer.mozilla.org/docs/Web/API/Streams_API +[modules]: https://github.com/hasundue/lophus/tree/main/lib +[nostr-tools]: https://github.com/nbd-wtf/nostr-tools [nostring]: https://github.com/xbol0/nostring [hono]: https://github.com/honojs/hono