From 33d0878eef53ad63e1c2c78b32864cb0ade7042f Mon Sep 17 00:00:00 2001 From: StephanHCB Date: Wed, 10 Jul 2024 11:21:58 +0200 Subject: [PATCH] chore(#29): documentation and action updates --- .github/workflows/go.yml | 6 +++--- LICENSE | 2 +- README.md | 16 +++------------- 3 files changed, 7 insertions(+), 17 deletions(-) diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml index 29934be..1301dc4 100644 --- a/.github/workflows/go.yml +++ b/.github/workflows/go.yml @@ -15,12 +15,12 @@ jobs: build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Set up Go - uses: actions/setup-go@v2 + uses: actions/setup-go@v5 with: - go-version: '1.20' + go-version: '^1.22.5' - name: Build run: go build -v ./... diff --git a/LICENSE b/LICENSE index d7dd97e..2b1585d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 StephanHCB +Copyright (c) 2022-2024 StephanHCB Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 54b1908..8c40819 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,6 @@ A rest client that combines ease of use with support for a number of resilience features. -## About go-autumn - -A collection of libraries for [enterprise microservices](https://github.com/StephanHCB/go-mailer-service/blob/master/README.md) in golang that -- is heavily inspired by Spring Boot / Spring Cloud -- is very opinionated -- names modules by what they do -- unlike Spring Boot avoids certain types of auto-magical behaviour -- is not a library monolith, that is every part only depends on the api parts of the other components - at most, and the api parts do not add any dependencies. - -Fall is my favourite season, so I'm calling it go-autumn. - ## About go-autumn-restclient It's a rest client that also supports x-www-form-urlencoded. @@ -28,7 +16,9 @@ Each of the individual features isn't spectacular, but in combination I've found - support for timeouts both at the httpclient and higher levels - support for plugging in a circuitbreaker (not included with this library, see [go-autumn-restclient-circuitbreaker](https://github.com/StephanHCB/go-autumn-restclient-circuitbreaker)) -- conditional retry (using a callback so you're flexible about the retry condition) +- support for prometheus metrics integration (not included with this library, see + [go-autumn-restclient-prometheus](https://github.com/StephanHCB/go-autumn-restclient-prometheus)) +- conditional retry (using a callback, so you're flexible about the retry condition) - support for plugging in a request cache - support for context aware request logging - support for pre-request header/request manipulation (using a callback)