add archival notice to README

This repository is being archived. Point readers at the standard-library or community package that replaces it. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-09-07 13:08:41 +01:00
3 changed files with 58 additions and 26 deletions
@@ -1,26 +0,0 @@
 # Vet and test the package. This is a pure Go library -- no build
 # step, no services -- so CI just runs `go vet` then `go test` on
 # every push to main and every pull request.
 name: CI
 on:
  push:
    branches:
      - main
  pull_request:
  workflow_dispatch:
 jobs:
  test:
    runs-on: ubuntu-latest
    container:
      image: golang:1.21-alpine
    steps:
      - name: Install checkout dependencies
        run: apk add --no-cache git nodejs
      - uses: actions/checkout@v4
      - name: go vet
        run: go vet ./...
      - name: go test
        run: go test ./...
@@ -0,0 +1,47 @@
 name: Test
 on:
  pull_request:
    branches:
      - develop
  push:
    branches:
      - develop
 jobs:
  test:
    name: Test
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      - name: Set up Go
        uses: actions/setup-go@v5
        with:
          go-version: ^1.21.0
      - name: Display Go version
        run: go version
      - name: Install dependencies
        run: go get
      - name: Run tests
        run: go test -v
  notify:
    name: Send Discord workflow notification
    runs-on: ubuntu-latest
    needs: test
    steps:
      - name: Send notification
        uses: annybs/action-notify-discord@v1
        if: ${{ always() }}
        with:
          repository: ${{ github.repository }}
          result: ${{ needs.test.result }}
          run-id: ${{ github.run_id }}
          run-number: ${{ github.run_number }}
          webhook-url: ${{ secrets.DISCORD_WEBHOOK }}
          workflow: ${{ github.workflow }}
@@ -1,3 +1,14 @@
 > [!IMPORTANT]
 > **This repository is archived and no longer maintained.**
 >
 > These are thin helpers over `net/http` and `encoding/json`.
 >
 > **Use instead:**
 > - Standard library `net/http` + `encoding/json`.
 > - [`github.com/go-chi/render`](https://github.com/go-chi/render) for request decoding and response/error rendering helpers.
 ---
 # Go REST
 Some handy functions for developing JSON-based REST APIs. In particular, it simplifies reading HTTP request bodies, writing HTTP response bodies, and handling errors.