Skip to content

Commit

Permalink
Updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
bamidev committed Feb 26, 2024
1 parent 9132a47 commit 71b1052
Showing 1 changed file with 5 additions and 14 deletions.
19 changes: 5 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,16 @@
# BrowserWindow

_BrowserWindow_ is a simple Rust crate for utilizing a browser engine to create a graphical user interface.
Just like [Electron.js](https://www.electronjs.org/), you can build your GUI with HTML, CSS & JS, or simply have some basic browser functionality at your disposal.
_BrowserWindow_ was born from the lack of a good and simple Electron alternative for Rust.
Just like [Electron.js](https://www.electronjs.org/), you can use it to build a GUI with HTML, CSS & JS, or just to have some basic browser functionality at your disposal.

![](preview.png)

## Introduction

_BrowserWindow_ is designed to be easy to use, and work cross-platform. It is built to work in Rust and utilizes the async/await syntax. It even has optional
thread-safe handles. There are currently two different underlying browser frameworks that can be
selected: WebkitGTK or CEF.

CEF (or the Chromium Embedding Framework) is recommended when used on Windows, but requires more
effort to set up.
WebkitGTK is recommended when used on Unix-like systems or when cross-compiling, and is genereally
pretty easy to set up.
Enable feature `cef` or `webkitgtk` to select either one.

Moreover, if you wish to use it in a multi-threaded environment, you can do that as well.
There are thread-safe handles available for easy exchange of data & work between the GUI thread and others.
_BrowserWindow_ is designed to be easy to use, and work cross-platform. It utilizes the async/await
syntax & it even has optional thread-safe handles. There are currently two different underlying
browser frameworks that can be selected: WebkitGTK or CEF.
These particular frameworks have cross-platform support.

You can look at some [examples](https://github.com/bamilab/browser-window/tree/master/examples) to
get an idea how you can use the api.
Expand Down

0 comments on commit 71b1052

Please sign in to comment.