Skip to content

Commit

Permalink
docs(readme): polish intro and features
Browse files Browse the repository at this point in the history
  • Loading branch information
hasundue committed Oct 2, 2023
1 parent 404c32e commit bf57acd
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,22 @@
[![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)
Expand All @@ -48,5 +41,11 @@ 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

<!-- Links -->

[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

0 comments on commit bf57acd

Please sign in to comment.