Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
akiomik committed Jan 14, 2024
1 parent c55ea6e commit 8a1d45d
Showing 1 changed file with 6 additions and 18 deletions.
24 changes: 6 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,28 @@
# nostui

[![crates.io](https://img.shields.io/crates/v/nostui.svg)](https://crates.io/crates/nostui)
[![CI](https://github.com/akiomik/nostui/workflows/CI/badge.svg)](https://github.com/akiomik/nostui/actions)

A TUI client for [Nostr](https://nostr.com)

![screenshot](screenshot.gif)

## Current features
## Current Features

- Timeline
- Post, Reply, Reaction, Repost

## Getting Started

### Requirements
Dowonload binaries from the [release](https://github.com/akiomik/nostui/releases/latest) page.

- git
- rust

### Installation

1. Clone this repository and move to the directory:

```shell
git clone https://github.com/akiomik/nostui
cd nostui
```

2. Install `nostui` binary:
Or, install manually via `crates.io`:

```shell
# Install to ~/.cargo/bin/nostui
cargo install --path .
cargo install nostui
```

### Setup
## Setup

> [!NOTE]
> Other extensions supported are `.json5`, `.yaml`, `.toml` and `.ini`.
Expand Down

0 comments on commit 8a1d45d

Please sign in to comment.