diff --git a/.gitignore b/.gitignore index 07cc0d3..ca993e0 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ noscl +dist diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0d992f0 --- /dev/null +++ b/LICENSE @@ -0,0 +1 @@ +Public domain. diff --git a/Makefile b/Makefile index 3c9e28f..8a27920 100644 --- a/Makefile +++ b/Makefile @@ -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}}" diff --git a/README.md b/README.md new file mode 100644 index 0000000..3cc17cd --- /dev/null +++ b/README.md @@ -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=] + noscl setprivate + noscl public + noscl publish [--reference=] + noscl profile [--page=] + noscl follow + noscl unfollow + noscl event [--page=] + noscl relay + noscl relay add + noscl relay remove +``` + +The basic flow is something like + +1. Add some relays with `noscl relay add ` (see https://moonbreeze.richardbondi.net/nostr-registry/ for some publicly available relays) +2. Follow some people with `noscl follow ` +3. Browse some profiles from people (you don't have to be following) with `noscl profile ` +4. See the feed of people you follow with `noscl home` +5. Set your own private key with `noscl setprivate ` +6. Get your public key with `noscl public` so you can share it with others +7. Publish some notes with `noscl publish `