Skip to content

Commit

Permalink
README update.
Browse files Browse the repository at this point in the history
  • Loading branch information
borut-t committed May 16, 2024
1 parent 9c1812e commit abee302
Show file tree
Hide file tree
Showing 154 changed files with 213 additions and 167 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2023 Povio Inc. <[email protected]>
Copyright (c) 2024 Povio Inc. <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
4 changes: 2 additions & 2 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,13 @@ let package = Package(
"PovioKitCore",
],
path: "Sources/Utilities",
resources: [.copy("../../../Resources/PrivacyInfo.xcprivacy")]
resources: [.copy("../../Resources/PrivacyInfo.xcprivacy")]
),
.target(
name: "PovioKitAsync",
dependencies: [],
path: "Sources/Async",
resources: [.copy("../../../Resources/PrivacyInfo.xcprivacy")]
resources: [.copy("../../Resources/PrivacyInfo.xcprivacy")]
),
.testTarget(
name: "Tests",
Expand Down
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,23 @@

## Packages

| [Core](Resources/Core) | [UI](Resources/UI) | [Networking](Resources/Networking) | [PromiseKit](Resources/PromiseKit) |
| :-: | :-: | :-: | :-: |
| [Core](Resources/Core) | [Networking](Resources/Networking) | [PromiseKit](Resources/PromiseKit) | [Utilities](Resources/Utilities) | [Async](Resources/Async) | [UIKit](Resources/UI/UIKit) | [SwiftUI](Resources/UI/SwiftUI) |
| :-: | :-: | :-: | :-: | :-: | :-: | :-: |

## Installation

### Swift Package Manager
- In Xcode, click `File` -> `Add Package Dependencies...`
- Insert `https://github.com/poviolabs/PovioKit` in the Search field.
- Select a desired `Dependency Rule`. Usually "Up to Next Major Version" with "3.0.0".
- Select a desired `Dependency Rule`. Usually "Up to Next Major Version" with "4.0.0".
- Select "Add Package" button and check one or all given products from the list:
- *PovioKitCore* (core library)
- *PovioKitNetworking* (networking library, depends on `core` and `promise` package)
- *PovioKitNetworking* (networking library built on top of Alamofire, has dependency on `PovioKitPromise` package)
- *PovioKitPromise* (lightweight promises library)
- *PovioKitUI* (UI components)
- *PovioKitUtilities* (utility components, has dependency on `PovioKitCore` package)
- *PovioKitAsync* (async/await components)
- *PovioKitUIKit* (UIKit components, has dependency on `PovioKitCore` and `PovioKitUtilities` package)
- *PovioKitSwiftUI* (SwiftUI components, has dependency on `PovioKitCore` package)
- Select "Add Package" again and you are done.

### Migration
Expand Down
8 changes: 8 additions & 0 deletions Resources/Async/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# PovioKit: Async

A package that includes async components and tools.

### Components
| Component | Description |
| :--- | :--- |
| [AsyncThrottleSequence](/Sources/Async/AsyncThrottleSequence) | A wrapper around an `AsyncSequence` that introduces a delay between tasks to control the rate at which elements are emitted. |
File renamed without changes.
27 changes: 5 additions & 22 deletions Resources/Core/README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,12 @@
# PovioKit: Core

Core package including essentials needed for development and other packages.
Core package includes essentials needed for the development and for other packages.

### Utilities

| Utilities |
### Essentials
| Components |
| :--- |
| [AppVersionValidator](/Sources/Core/Utilities/AppVersionValidator/AppVersionValidator.swift) |
| [AttributedStringBuilder](Utilities/AttributedStringBuilder) |
| [Broadcast](Utilities/Broadcast) |
| [BundleReader](/Sources/Core/Utilities/BundleReader/BundleReader.swift) |
| [ColorInterpolator](Utilities/ColorInterpolator) |
| [Delegated](Utilities/Delegated) |
| [DispatchTimer](Utilities/DispatchTimer) |
| [ImageSource](/Sources/Core/Utilities/ImageSource/ImageSource.swift) |
| [Logger](Utilities/Logger) |
| [Money](Utilities/Money) |
| [StartupService](Utilities/StartupService) |
| [Throttler](Utilities/Throttler) |
| [UserDefaults](Utilities/PropertyWrapper/UserDefaults) |
| [XCConfigValue](Utilities/PropertyWrapper/XCConfigValue) |
| [Logger](Logger) |


### Extensions

Expand All @@ -39,7 +26,3 @@ Core package including essentials needed for development and other packages.
| [UITableViewHeaderFooterView](/Sources/Core/Extensions/UIKit/UITableViewHeaderFooterView+PovioKit.swift) | | |
| [UIView](/Sources/Core/Extensions/UIKit/UIView+PovioKit.swift) | | |
| [UIViewController](/Sources/Core/Extensions/UIKit/UIViewController+PovioKit.swift) | | |




1 change: 0 additions & 1 deletion Resources/Networking/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

High-level network client abstraction based on [Alamofire](https://github.com/Alamofire/Alamofire).


## Usage

#### Retreiving JSON object from an endpoint
Expand Down
15 changes: 0 additions & 15 deletions Resources/UI/README.md

This file was deleted.

File renamed without changes.
File renamed without changes.
31 changes: 31 additions & 0 deletions Resources/UI/SwiftUI/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# PovioKit: SwiftUI

A package including components to help you out developing for SwiftUI framework.

### Components

| Views |
| :--- |
| [ActionButton](ActionButton) |
| [PhotoPickerView](/Sources/UI/SwiftUI/Views/PhotoPickerView/PhotoPickerView.swift) |
| [ProfileImageView](ProfileImageView) |
| [ProgressStyle](/Sources/UI/SwiftUI/Views/ProgressStyle/ProgressStyle.swift) |
| [RemoteImage](/Sources/UI/SwiftUI/Views/RemoteImage/RemoteImage.swift) |
| [ScrollViewWithOffset](/Sources/UI/SwiftUI/Views/ScrollViewWithOffset/ScrollViewWithOffset.swift) |

| View Modifiers |
| :--- |
| [MeasureSizeModifier](/Sources/UI/SwiftUI/View Modifiers/MeasureSizeModifier/MeasureSizeModifier.swift) |
| [OnFirstAppearModifier](/Sources/UI/SwiftUI/View Modifiers/OnFirstAppearModifier/OnFirstAppearModifier.swift) |
| [PhotoPickerModifier](/Sources/UI/SwiftUI/View Modifiers/PhotoPickerModifier/PhotoPickerModifier.swift) |
| [PinchToZoomModifier](/Sources/UI/SwiftUI/View Modifiers/PinchToZoomModifier/PinchToZoomModifier.swift) |
| [SquaredModifier](/Sources/UI/SwiftUI/View Modifiers/SquaredModifier/SquaredModifier.swift) |
| [TextFieldLimitModifer](/Sources/UI/SwiftUI/View Modifiers/TextFieldLimitModifer/TextFieldLimitModifer.swift) |

| Extensions |
| :--- |
| [AnyTransition](/Sources/UI/SwiftUI/Extensions/AnyTransition/AnyTransition+PovioKit.swift) |
| [Color](/Sources/UI/SwiftUI/Extensions/Color/Color+PovioKit.swift) |
| [Image](/Sources/UI/SwiftUI/Extensions/Image/Image+PovioKit.swift) |
| [Text](/Sources/UI/SwiftUI/Extensions/Text/Text+PovioKit.swift) |
| [View](/Sources/UI/SwiftUI/Extensions/View/View+PovioKit.swift) |
File renamed without changes.
File renamed without changes.
File renamed without changes.
12 changes: 12 additions & 0 deletions Resources/UI/UIKit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# PovioKit: UIKit

A package including components to help you out developing for UIKit framework.

### Components

| Views |
| :--- |
| [DynamicCollectionCell](DynamicCollectionCell) |
| [GradientView](GradientView) |
| [PaddingLabel](PaddingLabel) |
| [TextField](TextField) |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
25 changes: 25 additions & 0 deletions Resources/Utilities/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# PovioKit: Utilities

Core package including utility tools.

### Utilities

| Available Utilities |
| :--- |
| [AppVersionValidator](/Sources/Utilities/AppVersionValidator/AppVersionValidator.swift) |
| [AttributedStringBuilder](AttributedStringBuilder) |
| [Broadcast](Broadcast) |
| [BundleReader](/Sources/Utilities/BundleReader/BundleReader.swift) |
| [Camera](/Sources/Utilities/Camera) |
| [ColorInterpolator](ColorInterpolator) |
| [Delegated](Delegated) |
| [DispatchTimer](DispatchTimer) |
| [Exif](Exif) |
| [ImageSource](/Sources/Utilities/ImageSource/ImageSource.swift) |
| [InAppPurchase](InAppPurchase) |
| [MediaPlayer](/Sources/Utilities/MediaPlayer) |
| [Money](Money) |
| [Property wrapper: UserDefaults](PropertyWrapper/UserDefaults) |
| [Property wrapper: XCConfigValue](PropertyWrapper/XCConfigValue) |
| [StartupService](StartupService) |
| [Throttler](Throttler) |
File renamed without changes.
2 changes: 1 addition & 1 deletion Sources/Async/AsyncThrottleSequence.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Toni K. Turk on 22/08/2023.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

import Foundation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Povio Team on 26/04/2019.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

import Foundation
Expand Down
2 changes: 1 addition & 1 deletion Sources/Core/Extensions/Foundation/Data+PovioKit.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Povio Team on 21/08/2020.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

import Foundation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Borut Tomažin on 11/11/2020.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

import Foundation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Borut Tomažin on 11/11/2020.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

import Foundation
Expand Down
2 changes: 1 addition & 1 deletion Sources/Core/Extensions/Foundation/Double+PovioKit.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Borut Tomažin on 02/09/2022.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

import Foundation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Borut Tomažin on 11/11/2020.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

import Foundation
Expand Down
2 changes: 1 addition & 1 deletion Sources/Core/Extensions/Foundation/Optional+PovioKit.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Povio Team on 26/04/2019.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

import Foundation
Expand Down
2 changes: 1 addition & 1 deletion Sources/Core/Extensions/Foundation/Result+PovioKit.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// Alamofire
//
// Created by Borut Tomažin on 24/02/2020.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

import Foundation
Expand Down
2 changes: 1 addition & 1 deletion Sources/Core/Extensions/Foundation/String+PovioKit.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Povio Team on 26/04/2019.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

import Foundation
Expand Down
2 changes: 1 addition & 1 deletion Sources/Core/Extensions/Foundation/URL+PovioKit.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Povio Team on 26/04/2019.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

import Foundation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Borut Tomažin on 11/11/2020.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

import MapKit.MKAnnotationView
Expand Down
2 changes: 1 addition & 1 deletion Sources/Core/Extensions/MapKit/MKCircle+PovioKit.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Borut Tomažin on 11/11/2020.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

import MapKit.MKCircle
Expand Down
2 changes: 1 addition & 1 deletion Sources/Core/Extensions/MapKit/MKMapView+PovioKit.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Borut Tomažin on 11/11/2020.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

import MapKit.MKMapView
Expand Down
2 changes: 1 addition & 1 deletion Sources/Core/Extensions/MapKit/MKPolygon+PovioKit.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Borut Tomažin on 11/11/2020.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

import MapKit.MKPolygon
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Borut Tomažin on 23/06/2022.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

#if os(iOS)
Expand Down
2 changes: 1 addition & 1 deletion Sources/Core/Extensions/UIKit/UIApplication+PovioKit.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Borut Tomažin on 13/11/2020.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

#if os(iOS)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Povio Team on 26/4/2019.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

#if os(iOS)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Povio Team on 26/4/2019.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

#if os(iOS)
Expand Down
2 changes: 1 addition & 1 deletion Sources/Core/Extensions/UIKit/UIColor+PovioKit.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Povio Team on 26/4/2019.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

#if os(iOS)
Expand Down
2 changes: 1 addition & 1 deletion Sources/Core/Extensions/UIKit/UIDevice+PovioKit.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Povio Team on 26/4/2019.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

#if os(iOS)
Expand Down
2 changes: 1 addition & 1 deletion Sources/Core/Extensions/UIKit/UIEdgeInsets+PovioKit.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// PovioKit
//
// Created by Povio Team on 26/4/2019.
// Copyright © 2023 Povio Inc. All rights reserved.
// Copyright © 2024 Povio Inc. All rights reserved.
//

#if os(iOS)
Expand Down
Loading

0 comments on commit abee302

Please sign in to comment.