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

Update README #49

Merged
merged 1 commit into from
Jul 26, 2024
Merged

Update README #49

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
11 changes: 8 additions & 3 deletions README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@ An asynchronous Scala client for [Fastly's API](http://docs.fastly.com/api) used

[![fastly-api-client Scala version support](https://index.scala-lang.org/guardian/fastly-api-client/fastly-api-client/latest-by-scala-version.svg?platform=jvm)](https://index.scala-lang.org/guardian/fastly-api-client/fastly-api-client)

[Released to maven central](http://search.maven.org/#search%7Cga%7C1%7Cfastly-api-client)

[Release notes](https://github.com/guardian/fastly-api-client/releases)
[![Release](https://github.com/guardian/fastly-api-client/actions/workflows/release.yml/badge.svg)](https://github.com/guardian/fastly-api-client/actions/workflows/release.yml)

## Installation

Expand Down Expand Up @@ -78,3 +76,10 @@ You'll need a config file at ~/.config/fastly/fastlyApiClientTest with these val
apiKey=<api key with read-only access to above service>

You may wish to create a service just for this purpose.


# Publishing a new release

This repo uses [`gha-scala-library-release-workflow`](https://github.com/guardian/gha-scala-library-release-workflow)
to automate publishing releases (both full & preview releases) - see
[**Making a Release**](https://github.com/guardian/gha-scala-library-release-workflow/blob/main/docs/making-a-release.md).