docs: improve readme

Author: thde

Makefile

@@ -0,0 +1,55 @@
+APP_NAME ?= nctl
+
+# try getconf (linux / macos), getconf (BSD), nproc, then fallback to 1
+NPROCS := $(shell getconf _NPROCESSORS_ONLN 2>/dev/null || getconf NPROCESSORS_ONLN 2>/dev/null || nproc 2>/dev/null || echo 1)
+MAKEFLAGS += --jobs=$(NPROCS)
+
+.PHONY: all build test clean lint update help
+
+all: build
+
+build:
+	GITHUB_REPOSITORY=ninech/nctl goreleaser build --clean --snapshot --single-target
+
+test:
+	go test -race ./...
+
+lint: mod-tidy vet staticcheck golangci-lint modernize govulncheck
+
+lint-fix:
+	go mod tidy
+	golangci-lint run --fix
+	go run golang.org/x/tools/go/analysis/passes/modernize/cmd/modernize@latest -test -fix ./...
+	$(MAKE) lint
+
+mod-tidy:
+	go mod tidy -diff
+
+vet:
+	go vet ./...
+
+golangci-lint:
+	golangci-lint run
+
+staticcheck:
+	go run honnef.co/go/tools/cmd/staticcheck@latest ./...
+
+modernize:
+	go run golang.org/x/tools/go/analysis/passes/modernize/cmd/modernize@latest -test ./...
+
+govulncheck:
+	go run golang.org/x/vuln/cmd/govulncheck@latest ./...
+
+update:
+	go get -v -u ./... && go mod tidy
+
+clean:
+	rm -rf dist/
+
+help:
+	@echo "make           # Build $(APP_NAME)"
+	@echo "make test      # Run tests"
+	@echo "make lint-fix  # Run linters and try fix issues"
+	@echo "make lint      # Run linters"
+	@echo "make update    # Update dependencies"
+	@echo "make clean     # Remove built app"

README.md

@@ -1,15 +1,27 @@
 # nctl
 
-```bash
-$ nctl --help
-Usage: nctl <command>
+[![CI](https://github.com/ninech/nctl/actions/workflows/go.yml/badge.svg)](https://github.com/ninech/nctl/actions/workflows/go.yml)
+[![Release](https://img.shields.io/github/v/release/ninech/nctl)](https://github.com/ninech/nctl/releases)
+[![Go Report Card](https://goreportcard.com/badge/github.com/ninech/nctl)](https://goreportcard.com/report/github.com/ninech/nctl)
+[![License](https://img.shields.io/github/license/ninech/nctl)](LICENSE)
 
-Interact with Nine API resources. See https://docs.nineapis.ch for the full API docs.
+`nctl` is the command-line interface for [Nine](https://nine.ch)'s cloud platform.
+It lets you manage applications, services, storage, and more from your terminal.
 
-Run "nctl <command> --help" for more information on a command.
-```
+**[Documentation](https://docs.nine.ch/docs/nctl/)**
+
+## Resources
 
-## Setup
+| Category                   | Resources                                                          |
+| -------------------------- | ------------------------------------------------------------------ |
+| **deplo.io**               | Applications, Builds, Releases, Configs                            |
+| **storage.nine.ch**        | PostgreSQL, MySQL, OpenSearch, KeyValueStore, Buckets, BucketUsers |
+| **infrastructure.nine.ch** | Kubernetes Clusters, CloudVMs                                      |
+| **networking.nine.ch**     | ServiceConnections                                                 |
+| **iam.nine.ch**            | APIServiceAccounts                                                 |
+| **management.nine.ch**     | Projects                                                           |
+
+## Installation
 
 ```bash
 # If you have go already installed
@@ -37,13 +49,32 @@ dnf install nctl
 # Install yay: https://github.com/Jguer/yay#binary
 yay --version
 yay -S nctl-bin
+
+# EGet
+# Install eget https://github.com/zyedidia/eget
+eget ninech/nctl
 ```
 
-For Windows users, nctl is also built for arm64 and amd64. You can download the
-latest exe file from the [releases](https://github.com/ninech/nctl/releases) and
-install it.
+Binaries for macOS, Linux and Windows can be found on the [releases](https://github.com/ninech/nctl/releases) page.
+
+## Getting Started
+
+1. Login to the API: `nctl auth login`
+2. Explore available commands: `nctl --help`
+
+For complete documentation, tutorials, and guides, visit **[docs.nine.ch/docs/nctl/](https://docs.nine.ch/docs/nctl/)**.
+
+## Development
+
+```bash
+make           # Build nctl
+make test      # Run tests
+make lint      # Run linters
+make lint-fix  # Run linters and fix issues
+make update    # Update dependencies
+make clean     # Remove built artifacts
+```
 
-## Getting started
+## License
 
-* login to the API using `nctl auth login`
-* run `nctl --help` to get a list of all available commands
+[Apache 2.0](LICENSE)