Skip to content

Commit 920d0d9

Browse files
committed
Fix relative doc links in README so that they work on PyPI, and bump minor version for update
1 parent 531b665 commit 920d0d9

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ The general pattern for using the class is:
3333
* Confirm that the request was successful and use the provided LB's address
3434
* Acknowledge the `Response` via `ack_response(response)`
3535

36-
There are examples in the docs on how to do this in [an operator charm](docs/examples/requires_operator.md)
37-
or in [a reactive charm](docs/examples/requires_reactive.md).
36+
There are examples in the docs on how to do this in [an operator charm][requires_operator]
37+
or in [a reactive charm][requires_reactive].
3838

3939

4040
### Providing Load Balancers
@@ -48,15 +48,20 @@ general pattern for using the class is:
4848
* Set the appropriate fields on the request's `response` object
4949
* Send the request's response via the `send_response(request)` method
5050

51-
There are examples in the docs on how to do this in [an operator charm](docs/examples/provides_operator.md)
52-
or in [a reactive charm](docs/examples/provides_reactive.md).
51+
There are examples in the docs on how to do this in [an operator charm][provides_operator]
52+
or in [a reactive charm][provides_reactive].
5353

5454
## API Reference
5555

56-
See [the docs](docs/api.md) for detailed reference on the API.
56+
See the [API docs][] for detailed reference on the API.
5757

5858

5959
<!-- Links -->
6060

6161
[Operator Framework]: https://github.com/canonical/operator/
6262
[charms.reactive Framework]: https://charmsreactive.readthedocs.io/
63+
[requires_operator]: https://github.com/juju-solutions/loadbalancer-interface/blob/master/docs/examples/requires_operator.md
64+
[requires_reactive]: https://github.com/juju-solutions/loadbalancer-interface/blob/master/docs/examples/requires_reactive.md
65+
[provides_operator]: https://github.com/juju-solutions/loadbalancer-interface/blob/master/docs/examples/provides_operator.md
66+
[provides_reactive]: https://github.com/juju-solutions/loadbalancer-interface/blob/master/docs/examples/provides_reactive.md
67+
[API docs]: https://github.com/juju-solutions/loadbalancer-interface/blob/master/docs/api.md

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
SETUP = {
55
"name": "loadbalancer_interface",
6-
"version": "1.0.0",
6+
"version": "1.0.1",
77
"author": "Cory Johns",
88
"author_email": "[email protected]",
99
"url": "https://github.com/juju-solutions/loadbalancer-interface",

0 commit comments

Comments
 (0)