diff --git a/README.md b/README.md index 8c059d5..3ba848e 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,20 @@ Just like [Electron.js](https://www.electronjs.org/), you can use it to build a ## Introduction _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. +syntax & it even has optional thread-safe handles. There are currently three different underlying +browser frameworks that can be selected: CEF, WebkitGTK or Edge WebView2. +Each framework has their pros and cons, but CEF will be the most feature complete because it has the +best cross-platform support and the underlying engine is regularly worked on. 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. ## Getting Started -The underlying framework, be it CEF or WebkitGTK, needs to be installed on your system. There is a -[guide](./docs/GETTING-STARTED.md) to get you started with using _BrowserWindow_ on your own system. +The underlying browser framework does need some things to be set up on your system (although Edge +WebView2 may out-of-the-box on newer Windows installations). +But otherwise there is a [guide](./docs/GETTING-STARTED.md) to get you started with using +_BrowserWindow_ on your system. ## License @@ -28,9 +31,3 @@ minimum restrictions. ## Future Plans At the moment, there is a decent set of functionality available, but if something is lacking, please [submit an issue](https://github.com/bamilab/browser-window/issues), and I might implement it if it the functionality is common enough. - -Otherwise, here are some things that are yet to come: - -* Support for the Edge WebView2 framework on Windows. -* Events -* Support for Webkit + Cocoa on MacOS.