Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(#29): documentation and action updates #30

Merged
merged 1 commit into from
Jul 11, 2024
Merged

chore(#29): documentation and action updates #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/go.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ./...
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
16 changes: 3 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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)
Expand Down