Skip to content

Commit

Permalink
Pip update (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
UTXOnly authored May 12, 2024
1 parent b152041 commit 8bba436
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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:
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 8bba436

Please sign in to comment.