diff --git a/README.md b/README.md index d56ed38..f6fe109 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,20 @@ -# Project Name +# swift-log-elk + +![Swift5.0+](https://img.shields.io/badge/Swift-5.0%2B-orange.svg?style=flat) +[![release](https://img.shields.io/github/v/release/Apodini/swift-log-elk.svg?color=blue)](https://github.com/Apodini/swift-log-elk/releases) +[![codecov](https://codecov.io/gh/Apodini/swift-log-elk/branch/develop/graph/badge.svg?token=M9a8FsTExH)](https://codecov.io/gh/Apodini/swift-log-elk) +[![jazzy](https://raw.githubusercontent.com/Apodini/swift-log-elk/gh-pages/badge.svg)](https://apodini.github.io/swift-log-elk/) +[![Build and Test](https://github.com/Apodini/swift-log-elk/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/Apodini/swift-log-elk/actions/workflows/build-and-test.yml) +[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Apodini/swift-log-elk/blob/master/LICENSE) + +### **swift-log-elk is a logging backend library for Apple's logging API defined in swift-log**s + +## Features +- Written completly in Swift +- Supports both Darwin (macOS) and Linux platforms +- Uploads the log data automatically to Logstash (eg. the ELK stack) +- Caches the created log entries and sends them either periodically or when exceeding a certain configurable memory threshold to Logstash +- Logs itself via a background activity logger ## Requirements