Updated readme and assets.

ivanvorobei · ivanvorobei · commit cf9b649dd019 · 2023-04-10T15:18:53.000+03:00
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -1 +1 @@
-github: [ivanvorobei, sparrowcode]
+github: [sparrowcode]
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -5,11 +5,3 @@ title: ''
 labels: bug
 assignees: ivanvorobei
 ---
-
-**Details**
- - iOS Version [e.g. 15.2]
- - Framework Version [e.g. 1.0.2]
- - Installed via [e.g. SPM, Cocoapods, Manually]
- 
-**Describe the Bug**
-A clear and concise description of what the bug is.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -4,8 +4,4 @@ about: Suggest an idea for this project
 title: ''
 labels: enhancement
 assignees: ivanvorobei
-
 ---
-
-**Feature Description**
-Describe what functionality you want to see.
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,7 +1,2 @@
 ## Goal
 <!--- Provide details about reason changes. -->
-
-## Checklist
-<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
-- [] Testing in compability platforms
-- [] Installed correct via `Swift Package Manager` and `Cocoapods`
diff --git a/.gitignore b/.gitignore
@@ -1,9 +1,6 @@
-# osX files
+# macOS Files
 .DS_Store
 .Trashes
 
 # Swift Package Manager
 .swiftpm
-
-# User Interface
-*UserInterfaceState.xcuserstate
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,7 +1,6 @@
 # Contributing
 
-Here provided more info about project, contribution process and recomended changes.
-Please, read it before pull request or create issue.
+Here provided info about contribution process and recommendations.
 
 ## Codestyle 
 
@@ -28,5 +27,3 @@ Here you find all which using in project:
 - // MARK: - Internal
 - // MARK: - Models
 - // MARK: - Ovveride
-
-If you can't find valid, add new to codestyle agreements please. Other can be use if class is large and need struct it even without adding to codestyle agreements.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Ivan Vorobei
+Copyright (c) 2023 Sparrow Code
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/Package.swift b/Package.swift
@@ -3,7 +3,7 @@
 import PackageDescription
 
 let package = Package(
-    name: "SPSettingsIcons",
+    name: "SettingsIconGenerator",
     defaultLocalization: "en",
     platforms: [
         .iOS(.v13),
@@ -12,14 +12,14 @@ let package = Package(
     ],
     products: [
         .library(
-            name: "SPSettingsIcons",
-            targets: ["SPSettingsIcons"]
+            name: "SettingsIconGenerator",
+            targets: ["SettingsIconGenerator"]
         )
     ],
     dependencies: [],
     targets: [
         .target(
-            name: "SPSettingsIcons"
+            name: "SettingsIconGenerator"
         )
     ]
 )
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# SPSettingsIcons
+# SettingsIconGenerator
 
 Generate settings icons by Apple's SF Symbols.
 
@@ -16,6 +16,17 @@ Generate settings icons by Apple's SF Symbols.
 
 For safe using SFSymbols see [SPSafeSymbols](https://github.com/sparrowcode/SPSafeSymbols) library.
 
+<p float="left">
+    <a href="https://twitter.com/sparrowcode_en">
+        <img src="https://cdn.sparrowcode.io/github%2Fbadges%2Ftwitter.png?version=4" height="52">
+    </a>
+    <a href="#apps-using">
+        <img src="https://cdn.sparrowcode.io/github/badges/download-on-the-appstore.png?version=4" height="52">
+    </a>
+</p>
+
+## Navigate
+
 - [Installation](#installation)
     - [Swift Package Manager](#swift-package-manager)
     - [CocoaPods](#cocoapods)
@@ -31,27 +42,35 @@ Ready for use on iOS 13+.
 
 ### Swift Package Manager
 
-The [Swift Package Manager](https://swift.org/package-manager/) is a tool for automating the distribution of Swift code and is integrated into the `swift`  compiler. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.
+In Xcode go to Project -> Your Project Name -> `Package Dependencies` -> Tap *Plus*. Insert url:
 
-Once you have your Swift package set up, adding as a dependency is as easy as adding it to the `dependencies` value of your `Package.swift`.
+```
+https://github.com/sparrowcode/SettingsIconGenerator
+```
+
+or adding it to the `dependencies` of your `Package.swift`:
 
 ```swift
 dependencies: [
-    .package(url: "https://github.com/sparrowcode/SPSettingsIcons", .upToNextMajor(from: "1.0.0"))
+    .package(url: "https://github.com/sparrowcode/SettingsIconGenerator", .upToNextMajor(from: "1.0.0"))
 ]
 ```
-
 ### CocoaPods:
 
+This is an outdated way of doing things. I advise you to use [SPM](#swift-package-manager). However, I will continue to support Cocoapods for some time.
+
+<details><summary>Cocoapods Instalation</summary>
+
 [CocoaPods](https://cocoapods.org) is a dependency manager. For usage and installation instructions, visit their website. To integrate using CocoaPods, specify it in your `Podfile`:
 
 ```ruby
-pod 'SPSettingsIcons'
+pod 'SettingsIconGenerator'
 ```
+</details>
 
 ### Manually
 
-If you prefer not to use any of the dependency managers, you can integrate manually. Put `Sources/SPSettingsIcons` folder in your Xcode project. Make sure to enable `Copy items if needed` and `Create groups`.
+If you prefer not to use any of dependency managers, you can integrate manually. Put `Sources/SettingsIconGenerator` folder in your Xcode project. Make sure to enable `Copy items if needed` and `Create groups`.
 
 ## Usage
 
@@ -72,3 +91,17 @@ or if need generate image:
 ```swift
 Image.generateSettingsIcon("bell.fill", backgroundColor: .systemBlue)
 ```
+
+## Apps Using
+
+<p float="left">
+    <a href="https://apps.apple.com/app/id1624477055"><img src="https://cdn.sparrowcode.io/github/apps-using/id1624477055.png?version=2" height="65"></a>
+    <a href="https://apps.apple.com/app/id1625641322"><img src="https://cdn.sparrowcode.io/github/apps-using/id1625641322.png?version=2" height="65"></a>
+    <a href="https://apps.apple.com/app/id875280793"><img src="https://cdn.sparrowcode.io/github/apps-using/id875280793.png?version=2" height="65"></a>
+    <a href="https://apps.apple.com/app/id743843090"><img src="https://cdn.sparrowcode.io/github/apps-using/id743843090.png?version=2" height="65"></a>
+    <a href="https://apps.apple.com/app/id537070378"><img src="https://cdn.sparrowcode.io/github/apps-using/id537070378.png?version=2" height="65"></a>
+    <a href="https://apps.apple.com/app/id1570676244"><img src="https://cdn.sparrowcode.io/github/apps-using/id1570676244.png?version=2" height="65"></a>
+    <a href="https://apps.apple.com/app/id1617055933"><img src="https://cdn.sparrowcode.io/github/apps-using/id1617055933.png?version=2" height="65"></a>
+</p>
+
+If you use a `SettingsIconGenerator`, add your application via Pull Request.
diff --git a/SettingsIconGenerator.podspec b/SettingsIconGenerator.podspec
@@ -1,17 +1,17 @@
 Pod::Spec.new do |s|
 
-  s.name = 'SPSettingsIcons'
+  s.name = 'SettingsIconGenerator'
   s.version = '1.0.1'
   s.summary = 'Generator of settings icon by SF Symbols.'
-  s.homepage = 'https://github.com/sparrowcode/SPSettingsIcons'
-  s.source = { :git => 'https://github.com/sparrowcode/SPSettingsIcons.git', :tag => s.version }
+  s.homepage = 'https://github.com/sparrowcode/SettingsIconGenerator'
+  s.source = { :git => 'https://github.com/sparrowcode/SettingsIconGenerator.git', :tag => s.version }
   s.license = { :type => 'MIT', :file => "LICENSE" }
   s.author = { 'Ivan Vorobei' => 'hello@ivanvorobei.io' }
   
   s.swift_version = '5.1'
   s.ios.deployment_target = '13.0'
   s.tvos.deployment_target = '13.0'
 
-  s.source_files  = 'Sources/SPSettingsIcons/**/*.swift'
+  s.source_files  = 'Sources/SettingsIconGenerator/**/*.swift'
 
 end
diff --git a/Sources/SPSettingsIcons/SwiftUI+SettingsIcon.swift b/Sources/SPSettingsIcons/SwiftUI+SettingsIcon.swift
diff --git a/Sources/SPSettingsIcons/Values.swift b/Sources/SPSettingsIcons/Values.swift
diff --git a/Sources/SettingsIconGenerator/SwiftUI+SettingsIcon.swift b/Sources/SettingsIconGenerator/SwiftUI+SettingsIcon.swift
@@ -0,0 +1,21 @@
+#if canImport(SwiftUI)
+import SwiftUI
+
+@available(iOS 13, tvOS 13, macOS 11, *)
+public struct SettingsIcon: View {
+
+    let systemName: String
+    let backgroundColor: Color
+
+    public var body: some View {
+        ZStack {
+            Image(systemName: backgroundSystemName)
+                .font(.system(size: CGFloat(backgroundFontSize)))
+                .foregroundColor(backgroundColor)
+            Image(systemName: systemName)
+                .font(.system(size: CGFloat(iconFontSize)))
+                .foregroundColor(.white)
+        }
+    }
+}
+#endif
diff --git a/Sources/SettingsIconGenerator/UIImageExtensions.swift b/Sources/SettingsIconGenerator/UIImageExtensions.swift
@@ -1,24 +1,3 @@
-// The MIT License (MIT)
-// Copyright © 2022 Ivan Vorobei (hello@ivanvorobei.io)
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in all
-// copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-// SOFTWARE.
-
 #if canImport(UIKit)
 import UIKit
 
diff --git a/Sources/SettingsIconGenerator/Values.swift b/Sources/SettingsIconGenerator/Values.swift
@@ -0,0 +1,5 @@
+import Foundation
+
+var iconFontSize: Int { 16 }
+var backgroundFontSize: Int { 32 }
+var backgroundSystemName: String { "app.fill" }
diff --git a/TODO.md b/TODO.md

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-github: [ivanvorobei, sparrowcode]`
	`1`	`+github: [sparrowcode]`