Skip to content

Commit

Permalink
Update README and Logo after rename
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeehut committed Sep 5, 2024
1 parent 3e3625e commit 836a6ad
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
Binary file modified Images/PackageMappingInXcode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
![Foundation Logo](https://github.com/FlineDev/Foundation/blob/main/Logo.png?raw=true)
![Essentials Logo](https://github.com/FlineDev/Foundation/blob/main/Logo.png?raw=true)

# Foundation
# Essentials

This framework mainly consists of the files [AppFoundation.swift](https://github.com/FlineDev/Foundation/blob/main/Sources/AppFoundation/AppFoundation.swift) and [TestFoundation.swift](https://github.com/FlineDev/Foundation/blob/main/Sources/TestFoundation/TestFoundation.swift) which contain just a collection of `@_exported import` statements of frameworks I use in every new app.
This framework mainly consists of the files [SwiftUIPlus.swift](https://github.com/FlineDev/Foundation/blob/main/Sources/SwiftUIPlus/SwiftUIPlus.swift) and [FoundationPlus.swift](https://github.com/FlineDev/Foundation/blob/main/Sources/FoundationPlus/FoundationPlus.swift) which contain just a collection of `@_exported import` statements of frameworks I use in every new app.

## Usage

Just add `https://github.com/FlineDev/Foundation.git` as a Swift package, referencing the `main` branch and let Xcode load all commonly used dependencies.
Just add `https://github.com/FlineDev/Essentials.git` as a Swift package, referencing the `main` branch and let Xcode load all commonly used dependencies.

![Package Mapping in Xcode](https://github.com/FlineDev/Foundation/blob/main/Images/PackageMappingInXcode.png?raw=true)

Then, simply import `AppFoundation` or `TestFoundation` in your app or test targets Swift files and you no longer need to import `Foundation`, `SwiftUI`, `SwiftData`, `OSLog`, and a couple of other frameworks to eliminate the need for repeated imports. This serves a very similar purpose like the `import Foundation` Apple adds to every new Swift file by default, which is why I named this after that.
Then, simply import `SwiftUIPlus` or `FoundationPlus` in your app or test targets Swift files and you no longer need to import `Foundation`, `SwiftUI`, `SwiftData`, `OSLog`, and a couple of other frameworks to eliminate the need for repeated imports. This serves a very similar purpose like the `import SwiftUI` or `import Foundation` Apple adds to every new Swift(UI) file by default, which is why I named the targets `SwiftUIPlus` and `FoundationPlus`, respectively.

You are free to reference this framework as-is in your app, but note that I tend to use the latest Swift tools version at all times and that I might be adding or replacing frameworks over time without notice. So you might prefer to fork it and adjust it to your needs instead. That's mostly why I made this public.

## License

This library itself is released under the MIT License. See LICENSE for details.
For the licenses of the imported libraries, see their own LICENSE files. But I only use open-source libraries with a comparable LICENSE.

For the licenses of the imported libraries, see their own LICENSE files.

0 comments on commit 836a6ad

Please sign in to comment.