From f05dfff96a557c4c58cdd1ef6175390397682711 Mon Sep 17 00:00:00 2001
From: Ren Amamiya <123083837+reyamir@users.noreply.github.com>
Date: Tue, 21 Feb 2023 21:48:57 +0700
Subject: [PATCH] updated README
---
README.md | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
1 file changed, 86 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 608b7b88..96062fbb 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,89 @@
-# Tauri + Next.js + Typescript
+
+
+
+
+
+ 
+
+ Lume
+
+ An ambitious nostr client
+
+ uselume.xyz »
+
+ Download for
+ macOS
+ ·
+ Windows
+ ·
+ Linux
+ ·
+ iOS
+ ·
+ Android
+
+ ~ Links will be added once a release is available. ~
+
+
+Lume is an open source cross-platform Nostr client, powered by (Tauri) and Next.js | TailwindCSS.
+
+
-This template should help get you started developing with Tauri, Next.js and Typescript.
+> NOTE: Lume is under active development, most of the listed features are still experimental and subject to change.
-## Recommended IDE Setup
+Nostr is truly censorship-resistant protocol for social network and messenger app, combine with Bitcoin, they are powerful tools bring you to freedom. Lume is one of many great clients to help you interact with them, built with Tauri and Web-tech aiming for speed and efficiency
-- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
+Lume is simple as it is, no more buzzwords
+
+
+ 
+
+
+
+
+# How Nostr works?
+
+Everybody runs a client. It can be a native client, a web client, etc. To publish something, you write a post, sign it with your key and send it to multiple relays (servers hosted by someone else, or yourself). To get updates from other people, you ask multiple relays if they know anything about these other people. Anyone can run a relay. A relay is very simple and dumb. It does nothing besides accepting posts from some people and forwarding to others. Relays don't have to be trusted. Signatures are verified on the client side. [Learn more](https://github.com/nostr-protocol/nostr)
+
+# Motivation
+
+When Nostr became popular, many clients exist but none of them satisfy me, so I built my own. I don't many experence in develop desktop app before, my background is just strongly in Ruby on Rails, this is also a good opportunity for me to improve my skills.
+
+# Why desktop only?
+
+Lume is "an ambitious nostr client", so I don't want to limit it be a part of your daily web browsing, I want it to be a part of your computer. With a desktop app, I can explore more potentials, and in my opinion, web is broken I don't want to focus on it anymore (I will share more about this opinion later)
+
+# Features
+
+TODO
+
+# Roadmap
+
+TODO
+
+# Developer Guide
+
+TODO: add more detail and contributor guide
+
+1. Clone repo
+
+```
+git clone git@git.sr.ht:~reya/
+cd lume-desktop/
+```
+
+2. Install packages
+
+```
+pnpm install
+```
+
+3. Start a development build
+
+```
+pnpm tauri dev
+```
+
+# Repo structure
+
+TODO