Update README.md

This commit is contained in:
Zaphik 2024-10-03 11:59:59 +01:00 committed by GitHub
parent dd506c4afa
commit 274773ec28
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,3 +1,47 @@
# AdwaitaWebViewSwift
# WebView
A WebView widget for [Adwaita-Swift](https://github.com/AparokshaUI/adwaita-swift) that uses **WebKitGTK6.0** .
_WebView_ adds support for embedding a (you guessed it)webview into GNOME apps built using [Adwaita For Swift](https://github.com/AparokshaUI/adwaita-swift)
## Table of Contents
- [Installation](#Installation)
- [Usage](#Usage)
- [Thanks](#Thanks)
## Installation
### Dependencies
Install `webkitgtk6.0-dev` or similar (based on the package manager) as well as `gtk4-devel` and `libadwaita-dev` (or similar).
### Examples
* Debian and derivatives
```
sudo apt install libadwaita-1-dev libwebkitgtk-6.0-dev libgtk-4-dev
```
* Fedora and derivatives
```
sudo dnf install libadwaita-devel webkitgtk6.0-devel gtk4-devel
```
### Swift Package
1. Open your Swift package in GNOME Builder, or any other IDE.
2. Open the `Package.swift` file.
3. Into the `Package` initializer, under `dependencies`, paste:
```swift
.package(url: "https://github.com/Zaphik/AdwaitaWebViewSwift", branch: "main")
```
## Usage
Take a look at the simple [sample app](Tests/main.swift).
Check out the [Adwaita](https://github.com/AparokshaUI/Adwaita) packages.
## Thanks
### Dependencies
- [Adwaita](https://github.com/AparokshaUI/Adwaita) licensed under the [GPL-3.0 license](https://github.com/AparokshaUI/Adwaita/blob/main/LICENSE.md)
### Other Thanks
- The programming language [Swift](https://github.com/apple/swift)
- [WebKitGTK](https://webkitgtk.org/) for the widgets
- [CodeEditor](https://github.com/AparokshaUI/CodeEditor) for the guide on embedding widgets