Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
malcommac committed Dec 16, 2022
1 parent c4f0599 commit 43c8e90
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ It's designed to be:
- **PERFORMANT**: you can use Glider without the worry of impacting your app performances
- **UNIVERSAL**: it supports 14+ transports to satisfy every need; you can create your transport too!

# Why Logging?
# Why logging?

Logging and monitoring are fundamental parts of our job as engineers.
Especially in the mobile world (with very heterogeneous environments), you'll often find yourself in a situation where understanding how your software behaves in production is essential.

That's the right job for logging: logged data provide valuable information that would be difficult to gather otherwise, unveil unexpected behaviors and bugs, and even if the data was adequately anonymized, identify the sequences of actions of singular users.

# Feature Highlights
# Feature highlights

We loved making this open-source package and would see engineers like you using this software.
Those are five reasons you will love Glider:
Expand All @@ -34,7 +34,7 @@ Those are five reasons you will love Glider:
- 📚 A fully documented code via Apple's DocC ([link](https://swiftpackageindex.com/immobiliare/Glider))
- ⚙️ An extensive unit test suite

# One line implementation
# What you get

Creating a logger is simple.
Each logger is an instance of the `Log` class; typically, you need to specify one or more transports (where the data is stored).
Expand Down Expand Up @@ -84,7 +84,7 @@ A separate transport is able to capture automatically every network request and
</picture>
</p>

## API Reference
## APIs

Glider is fully documented at source-code level. You'll get autocomplete with doc inside XCode for free; moreover, you can read the full Apple's DoCC Documentation automatically generated by [**Swift Package Index**](https://swiftpackageindex.com) project from here:

Expand Down Expand Up @@ -149,7 +149,7 @@ Glider offers an extensive suite of unit tests for Glider Core Logger and third-

Moreover, the entire package is powered by [SwiftLint](https://github.com/realm/SwiftLint) for better code quality.

# Help Us!
# Contribute

If you want to join this project, we're maintaining a list of new features we would like to implement into the following versions of Glider.
Please open an issue and discuss one of them with us!
Expand All @@ -167,11 +167,13 @@ Glider can be installed on any platform which supports:
- Xcode 13.2

> NOTE:
> The followinG transports require newer OSs versions (iOS 13+, tvOS 13+ and macOS 10.15+):
> The following transports require newer OSs versions (iOS 13+, tvOS 13+ and macOS 10.15+):
> RemoteTransportServer, RemoteTransportServerClient
# Installation

Our preferred installation method is SPM but we're still support CocoaPods.

## Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler. It is in early development, but Glider does support its use on supported platforms.
Expand Down

0 comments on commit 43c8e90

Please sign in to comment.