diff --git a/README.md b/README.md index 1839351..daa0daf 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ + + + + LNbits + + + +[![License: MIT](https://img.shields.io/badge/License-MIT-success?logo=open-source-initiative&logoColor=white)](./LICENSE) +[![Built for LNbits](https://img.shields.io/badge/Built%20for-LNbits-4D4DFF?logo=lightning&logoColor=white)](https://github.com/lnbits/lnbits) + # Nostr Market ([NIP-15](https://github.com/nostr-protocol/nips/blob/master/15.md)) - [LNbits](https://github.com/lnbits/lnbits) extension For more about LNBits extension check [this tutorial](https://github.com/lnbits/lnbits/wiki/LNbits-Extensions). @@ -147,3 +157,10 @@ Stall and product are _Parameterized Replaceable Events_ according to [NIP-33](h Order placing, invoicing, payment details and order statuses are handled over Nostr using [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md). Customer support is handled over whatever communication method was specified. If communicationg via nostr, [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md) is used. + +## Powered by LNbits + +[LNbits](https://lnbits.com) is a free and open-source lightning accounts system. + +[![Visit LNbits Shop](https://img.shields.io/badge/Visit-LNbits%20Shop-7C3AED?logo=shopping-cart&logoColor=white&labelColor=5B21B6)](https://shop.lnbits.com/) +[![Try myLNbits SaaS](https://img.shields.io/badge/Try-myLNbits%20SaaS-2563EB?logo=lightning&logoColor=white&labelColor=1E40AF)](https://my.lnbits.com/login) diff --git a/config.json b/config.json index 1aa34a8..3a670de 100644 --- a/config.json +++ b/config.json @@ -1,12 +1,15 @@ { - "name": "Nostr Market", + "id": "nostrmarket", "version": "1.1.0", + "name": "Nostr Market", + "repo": "https://github.com/lnbits/nostrmarket", "short_description": "Nostr Webshop/market on LNbits", - "tile": "/nostrmarket/static/images/nostr-market.png", + "description": "", + "tile": "/nostrmarket/static/images/bitcoin-shop.png", "min_lnbits_version": "1.4.0", "contributors": [ { - "name": "motorina0", + "name": "Vlad Stan", "uri": "https://github.com/motorina0", "role": "Contributor" }, @@ -19,6 +22,11 @@ "name": "talvasconcelos", "uri": "https://github.com/talvasconcelos", "role": "Developer" + }, + { + "name": "BenGWeeks", + "uri": "https://github.com/BenGWeeks", + "role": "Developer" } ], "images": [ @@ -44,5 +52,9 @@ ], "description_md": "https://raw.githubusercontent.com/lnbits/nostrmarket/main/description.md", "terms_and_conditions_md": "https://raw.githubusercontent.com/lnbits/nostrmarket/main/toc.md", - "license": "MIT" + "license": "MIT", + "paid_features": "", + "tags": ["Nostr", "Marketplace"], + "donate": "", + "hidden": false } diff --git a/description.md b/description.md index 6446ca7..3cfe8bc 100644 --- a/description.md +++ b/description.md @@ -1,12 +1,10 @@ -> IMPORTANT: Nostr market needs the nostr-client extension installed. +Buy and sell products over Nostr using the NIP-15 marketplace protocol. -Buy and sell things over Nostr, using NIP15 https://github.com/nostr-protocol/nips/blob/master/15.md +Its functions include: -Nostr was partly based on the the previous version of this extension "Diagon Alley", so lends itself very well to buying and sellinng over Nostr. +- Managing products, sales, and customer communication as a merchant +- Browsing and ordering products as a customer +- Tracking order status and delivery +- Communicating via NIP-04 encrypted direct messages -The Nostr Market extension includes: - -- A merchant client to manage products, sales and communication with customers. -- A customer client to find and order products from merchants, communicate with merchants and track status of ordered products. - -All communication happens over NIP04 encrypted DMs. +A decentralized commerce solution for merchants and buyers who want to trade goods and services over Nostr with end-to-end encrypted communication.