Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
iabudiab committed Feb 13, 2021
1 parent 6e85772 commit eafe481
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,40 @@
# Swiftkube:ServiceDiscovery

<p align="center">
<img src="https://img.shields.io/badge/Swift-5.2-orange.svg" />
<a href="https://v1-18.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/">
<img src="https://img.shields.io/badge/Kubernetes-1.18.13-blue.svg" alt="Kubernetes 1.18.13"/>
</a>
<img src="https://img.shields.io/badge/SwiftkubeClient-0.6.0-blue.svg" />
<a href="https://swift.org/package-manager">
<img src="https://img.shields.io/badge/swiftpm-compatible-brightgreen.svg?style=flat" alt="Swift Package Manager" />
</a>
<img src="https://img.shields.io/badge/platforms-mac+linux-brightgreen.svg?style=flat" alt="Mac + Linux" />
<a href="https://github.com/swiftkube/servicediscovery/actions">
<img src="https://github.com/swiftkube/servicediscovery/workflows/swiftkube-servicediscovery-ci/badge.svg" alt="CI Status">
</a>
</p>

An implementation of the [Swift Service Discovery API](https://github.com/apple/swift-service-discovery) for Kubernetes based on [SwiftkubeClient](https://github.com/swiftkube/client).

## Table of contents

* [Overview](#overview)
* [Usage](#usage)
* [RBAC](#rbac)
* [Installation](#installation)
* [License](#license)

#Overview

- [x] Auto-configuration for different environments
- [x] Support for all K8s `ListOptions`
- [x] Support for reconnect and retry
- [x] Discovery for K8s Pod objects
- [ ] Discovery for K8s Service objects
- [ ] Complete documentation
- [ ] End-to-end tests

## Usage

### Creating a service discovery
Expand Down

0 comments on commit eafe481

Please sign in to comment.