Skip to content

Commit

Permalink
book: update introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
yukibtc committed Jan 18, 2024
1 parent 7bfed6e commit f7f1595
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions book/src/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,37 @@
<h1 align="center">
<code>rust-nostr</code>
</h1>
<div align="center">
<h1>
<code>rust-nostr</code>
</h1>
<h4>
<a href="https://github.com/rust-nostr">Project Homepage</a>
<span> | </span>
<a href="https://github.com/rust-nostr/nostr">Repository</a>
</h4>
<h1 style="font-size: 16px; font-weight: normal;">
The <code>nostr</code> development kit to build <strong>fast</strong>, <strong>stable</strong> and <strong>efficient</strong> apps for <strong>any environment</strong>!
</h1>
</div>

Build **fast**, **stable** and **efficient** nostr apps for **any environment**: desktop/server, mobile, embedded devices and web.


## Why rust-nostr?

* **Multi-Language Support**: We support native API's including `Rust`, `Python`, `JavaScript`, `Kotlin` and `Swift` so you can build `nostr` apps in your preferred programming language.

* **Multi-Platform Support**: Write nostr apps for `desktop`, `server`, `mobile`, `web` and/or `embedded` devices!

* **WASM Compatibility**: Most of our libraries compile to `WebAssembly` so that they can be integrated into web applications.

* **High performance**: Powered by `Rust`'s unparalleled `performance` and `memory safety`, our libraries offers `speed`, `stability` and `reliability`. The same features are extended to its `bindings` in other languages, ensuring optimal stability across diverse development environments.

* **Broad NIP Support**: Support to most relevant `NIPs`.

* **Customizable**: The libraries are built in modular way, allowing to build customized nostr apps.

## Libraries

* [Nostr](./nostr/01-index.md): Implementation of the `nostr` protocol
* [Nostr Database](): Databases abstraction, indexes and in-memory database implementation
* [Nostr SDK](./nostr-sdk/01-index.md): High level nostr client library

## State
Expand Down

0 comments on commit f7f1595

Please sign in to comment.