Skip to content
This repository has been archived by the owner on Jun 20, 2024. It is now read-only.

Commit

Permalink
README and release.
Browse files Browse the repository at this point in the history
  • Loading branch information
fiatjaf committed Feb 7, 2021
1 parent 3abe73b commit 2e20ebc
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
noscl
dist
1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Public domain.
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
noscl: $(shell find . -name "*.go")
go build -ldflags="-s -w" -o ./noscl

dist: $(shell find . -name "*.go")
mkdir -p dist
gox -ldflags="-s -w" -osarch="windows/amd64 darwin/amd64 linux/386 linux/amd64 linux/arm freebsd/amd64" -output="dist/noscl_{{.OS}}_{{.Arch}}"
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
noscl
=====

Command line client for [Nostr](https://github.com/fiatjaf/noscl).

## Installation

Compile with `go get github.com/fiatjaf/noscl` or [download a binary](releases/).

## Usage

```
noscl
Usage:
noscl home [--page=<page>]
noscl setprivate <key>
noscl public
noscl publish [--reference=<id>] <content>
noscl profile <key> [--page=<page>]
noscl follow <key>
noscl unfollow <key>
noscl event <id> [--page=<page>]
noscl relay
noscl relay add <url>
noscl relay remove <url>
```

The basic flow is something like

1. Add some relays with `noscl relay add <relay url>` (see https://moonbreeze.richardbondi.net/nostr-registry/ for some publicly available relays)
2. Follow some people with `noscl follow <pubkey>`
3. Browse some profiles from people (you don't have to be following) with `noscl profile <pubkey>`
4. See the feed of people you follow with `noscl home`
5. Set your own private key with `noscl setprivate <hex private key>`
6. Get your public key with `noscl public` so you can share it with others
7. Publish some notes with `noscl publish <my note content>`

0 comments on commit 2e20ebc

Please sign in to comment.