Skip to content

Commit 0c2afdb

Browse files
authored
docs: update README links and text (#356)
We have neglected the README and some links and text have become outdated.
1 parent cfd2dd3 commit 0c2afdb

File tree

1 file changed

+7
-12
lines changed

1 file changed

+7
-12
lines changed

README.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# brokerapi
22

3-
[![test](https://github.com/pivotal-cf/brokerapi/workflows/run-tests/badge.svg?branch=main)](https://github.com/pivotal-cf/brokerapi/actions/workflows/run-tests.yml?query=branch%3Amain)
3+
[![test](https://github.com/cloudfoundry/brokerapi/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/cloudfoundry/brokerapi/actions/workflows/run-tests.yml?query=branch%3Amain)
4+
5+
https://github.com/cloudfoundry/brokerapi/actions/workflows/run-tests/badge.svg?query=branch%3Amain
46

57
A Go package for building [V2 Open Service Broker API](https://github.com/openservicebrokerapi/servicebroker/) compliant Service Brokers.
68

7-
## [Docs](https://godoc.org/github.com/pivotal-cf/brokerapi/v11)
9+
## [Docs](https://godoc.org/code.cloudfoundry.org/brokerapi/v13)
810

911
## Dependencies
1012

@@ -18,18 +20,11 @@ We appreciate and welcome open source contribution. We will try to review the ch
1820
## Usage
1921

2022
`brokerapi` defines a
21-
[`ServiceBroker`](https://godoc.org/github.com/pivotal-cf/brokerapi/v11#ServiceBroker)
23+
[`ServiceBroker`](https://godoc.org/code.cloudfoundry.org/brokerapi/v13/domain#ServiceBroker/domain#ServiceBroker)
2224
interface. Pass an implementation of this to
23-
[`brokerapi.New`](https://godoc.org/github.com/pivotal-cf/brokerapi/v11#New)
24-
or [`brokerapi.NewWithOptions`](https://pkg.go.dev/github.com/pivotal-cf/brokerapi/v11#NewWithOptions),
25+
[`brokerapi.New`](https://godoc.org/code.cloudfoundry.org/brokerapi/v13#New),
2526
which returns an `http.Handler` that you can use to serve handle HTTP requests.
2627

27-
Alternatively, if you already have a `*chi.Mux` that you want to attach
28-
service broker routes to, you can use
29-
[`brokerapi.AttachRoutes`](https://godoc.org/github.com/pivotal-cf/brokerapi/v11#AttachRoutes).
30-
Note in this case, the Basic Authentication and Originating Identity middleware
31-
will not be set up, so you will have to attach them manually if required.
32-
3328
## Error types
3429

3530
`brokerapi` defines a handful of error types in `service_broker.go` for some
@@ -93,5 +88,5 @@ service broker uses the BrokerAPI package to create a service broker for Redis.
9388

9489
## Releasing
9590

96-
Releasing steps can be found [here](https://github.com/pivotal-cf/brokerapi/wiki/Releasing-new-BrokerAPI-major-version)
91+
Releasing steps can be found [here](https://github.com/cloudfoundry/brokerapi/wiki/Releasing-new-BrokerAPI-major-version)
9792

0 commit comments

Comments
 (0)