From 8bba4365edf2f2794a2b191ceb414ea21bd495e0 Mon Sep 17 00:00:00 2001 From: Brian Hartford Date: Sun, 12 May 2024 00:45:36 -0400 Subject: [PATCH] Pip update (#2) --- README.md | 21 +++++++++++++-------- pyproject.toml | 2 +- 2 files changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c8e0f0e..da86e12 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # nostpy-cli -`nostpy-cli` is a Command Line Interface (CLI) tool designed to handle nostpy events efficiently. This tool provides easy-to-use commands to send and query events via a WebSocket connection. +`nostpy-cli` is a Command Line Interface tool for sending and querying nostr events by websocket connection. ## Features -- Send events to a specified relay. -- Query events from a relay. +- Send events to a specified relays +- Query events from relays +- Encode/decode kind4 messages +- Supports [NIP-50](https://github.com/nostr-protocol/nips/blob/master/50.md) searches ## Prerequisites @@ -15,6 +17,13 @@ Before installing `nostpy-cli`, ensure you have Python 3.6 or higher installed o python3 --version ``` ## Installation + +### Install Using pip +To install using `pip` use the command below: +``` +pip install nostpy-cli +``` + ### Build from source Clone the Repository First, clone the repository to your local machine: @@ -26,11 +35,7 @@ python3 -m build pip install . ``` -### Install Using pip -To install using `pip` use the command below: -``` -pip install nostpy-cli -``` + ## Usage Once installed, you can run nostpy-cli from the command line. Below are some examples of how to use the CLI tool: diff --git a/pyproject.toml b/pyproject.toml index f9e4ff3..22decc0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "nostpy-cli" -version = "0.1.0" +version = "0.1.3" authors = [{ name = "Brian Hartford", email = "bh419@protonmail.com" }] description = "CLI tool for handling nostpy events" readme = "README.md"