Skip to content

Commit

Permalink
Add README (#2)
Browse files Browse the repository at this point in the history
* Add license

* Add README

* Add assets
  • Loading branch information
raymondjavaxx committed Aug 4, 2023
1 parent 11613c3 commit a1fb836
Show file tree
Hide file tree
Showing 4 changed files with 91 additions and 0 deletions.
19 changes: 19 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (c) 2023 Ramon Torres

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.
72 changes: 72 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# SmoothGradient

A SwiftUI framework for creating smooth gradients using easing functions.

## Motivation

Linear gradients tend to produce hard edges, which are more noticeable when transitioning between highly contrasting colors. This framework provides a simple way to create smoother gradients using easing functions.

| Linear | Smooth |
| --- | --- |
| ![Linear Gradient](assets/linear_gradient.png) | ![Smooth Gradient](assets/smooth_gradient.png) |


## Installation

### Swift Package Manager

Add the following to your `Package.swift` file:

```swift
.package(url: "https://github.com/raymondjavaxx/SmoothGradient.git", from: "1.0.0")
```

To add from Xcode, go to *File* -> *Add Package Dependencies...* and enter the URL above.

### CocoaPods

Add the following to your `Podfile`:

```ruby
pod 'SmoothGradient', '~> 1.0.0'
```

## Usage

### Pre-iOS 17

```swift
import SmoothGradient

struct ContentView: View {
var body: some View {
LinearGradient(
gradient: .smooth(from: .black, to: .white, curve: .easeInOut),
startPoint: .top,
endPoint: .bottom
)
}
}
```

## iOS 17+

```swift
import SmoothGradient

struct ContentView: View {
var body: some View {
SmoothLinearGradient(
from: .black,
to: .white,
curve: .easeInOut,
startPoint: .top,
endPoint: .bottom
)
}
}
```

## License

SmoothGradient is available under the MIT license. See the [LICENSE](LICENSE) file for more info.
Binary file added assets/linear_gradient.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 added assets/smooth_gradient.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a1fb836

Please sign in to comment.