Skip to content

docs: add README#3

Merged
mickamy merged 3 commits intomainfrom
docs/add-readme
Feb 26, 2026
Merged

docs: add README#3
mickamy merged 3 commits intomainfrom
docs/add-readme

Conversation

@mickamy
Copy link
Copy Markdown
Owner

@mickamy mickamy commented Feb 26, 2026

No description provided.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds initial project documentation and release metadata so slog-pretty can be installed/consumed more easily (CLI, library, and packaging).

Changes:

  • Add a comprehensive README.md with install/usage examples and option/flag documentation.
  • Add an MIT LICENSE.
  • Add a .goreleaser.yaml configuration for building archives and publishing a Homebrew formula.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
README.md Introduces installation/usage docs and lists CLI flags + handler/options.
LICENSE Adds MIT license text for project distribution.
.goreleaser.yaml Defines GoReleaser build, archive, and Homebrew tap publishing configuration.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md

### Docker

```dockerfile
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Dockerfile snippet uses ${TARGETARCH} but doesn’t declare it as a build arg. For copy/paste users this typically expands to an empty string and breaks the download URL; declare ARG TARGETARCH (and optionally ARG TARGETOS) before using it, or hardcode the arch in the example.

Suggested change
```dockerfile
```dockerfile
ARG TARGETARCH=amd64

Copilot uses AI. Check for mistakes.
Comment thread README.md

```bash
air | spretty
go run ./cmd/server | spretty
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example references go run ./cmd/server, but this repository doesn’t have a cmd/server package. Consider changing it to a generic placeholder (e.g., go run ./path/to/your/app | spretty) to avoid users hitting a "directory not found" error.

Suggested change
go run ./cmd/server | spretty
go run ./path/to/your/app | spretty

Copilot uses AI. Check for mistakes.
@mickamy mickamy merged commit 6d5762e into main Feb 26, 2026
4 checks passed
@mickamy mickamy deleted the docs/add-readme branch February 26, 2026 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants