Skip to content

Commit

Permalink
doc: Update Docc
Browse files Browse the repository at this point in the history
  • Loading branch information
JT501 committed Apr 15, 2024
1 parent 14a1703 commit df67105
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 19 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
69 changes: 50 additions & 19 deletions Sources/SwiftNotify/SwiftNotify.docc/SwiftNotify.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,19 @@ A *Swifty* UI framework for **notifications** and **alerts**.

## Overview

**SwiftNotify** makes notifications interactive, playable and fun!

![Demo](Demo1)
**SwiftNotify** makes notifications interactive, playful and fun!

@Row {
@Column {
![Demo](Demo1)
}
@Column {
![Demo](Demo2)
}
@Column {
![Demo](Demo3)
}
}

SwiftNotify uses *UIKit Dynamics* as animator to create smooth interactive animations and physics behaviours for the notices.

Expand All @@ -19,30 +29,51 @@ SN.show(title: "OMG", message: "SwiftNotify is Great !", level: .success)

As simple as that.

## Requirements
- Swift 5.5+
- iOS 13.0+

### Themes

SwiftNotify provides six beautiful ``Theme``s for notices.
In additional, every theme has four ``Level``: **success**, **fail**, **warning** and **info**.

They are:
- **``SwiftNotify/Theme/cyber``**
![Cyber](Cyber)
- **``SwiftNotify/Theme/cyberDark``**
![CyberDark](CyberDark)
- **``SwiftNotify/Theme/classic``**
![Classic](Classic)
- **``SwiftNotify/Theme/classicDark``**
![ClassicDark](ClassicDark)
- **``SwiftNotify/Theme/toast``**
![Toast](Toast)
- **``SwiftNotify/Theme/toastDark``**
![ToastDark](ToastDark)

Every theme has its own appearence configuration (``ThemeConfig``). And every level has its own appearence configuration (``LevelConfig``).
- **Cyber**

@TabNavigator {
@Tab("Light") {
![Cyber](Cyber)
}
@Tab("Dark") {
![CyberDark](CyberDark)
}
}

- **Classic**

@TabNavigator {
@Tab("Light") {
![Classic](Classic)
}
@Tab("Dark") {
![ClassicDark](ClassicDark)
}
}

- **Toast**

@TabNavigator {
@Tab("Light") {
![Toast](Toast)
}
@Tab("Dark") {
![ToastDark](ToastDark)
}
}

## Requirements
- Swift 5.5+
- iOS 13.0+
Every theme has its own appearence configuration (``ThemeConfig``). And every level has its own appearence configuration (``LevelConfig``).

## Topics

Expand Down

0 comments on commit df67105

Please sign in to comment.