starred/Electron.NET
1
0
Fork 0
mirror of https://github.com/ElectronNET/Electron.NET.git synced 2026-09-22 06:54:44 +00:00
Code Issues 668 Packages Projects Releases 20 Wiki Activity

Update readme with more info

Browse Source 
* requirements (https://github.com/ElectronNET/Electron.NET/issues/27)
* tell our user how Electron.NET works
This commit is contained in:
Robert Muehsig
2017-11-03 22:12:09 +01:00
committed by GitHub
parent 0ad6358d16
commit 33df6e38fc
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -5,13 +5,20 @@ AppVeyor (Win/Linux): [![Build status](https://ci.appveyor.com/api/projects/stat
Travis-CI (Win/OSX/Linux): [![Build Status](https://travis-ci.org/ElectronNET/Electron.NET.svg?branch=master)](https://travis-ci.org/ElectronNET/Electron.NET)
Build cross platform desktop apps with .NET Core 2.0 and ASP.NET NET Core.
Build cross platform desktop apps with .NET Core 2.0 and ASP.NET NET Core.
Electron.NET is a wrapper around a "normal" Electron application with a embedded ASP.NET Core application. Via our Electron.NET IPC bridge we can invoke Electron APIs from .NET.
The CLI extensions hosts our toolset to build and start Electron.NET applications.
# NuGet:
* API [![NuGet](https://img.shields.io/nuget/v/ElectronNET.API.svg?style=flat-square)](https://www.nuget.org/packages/ElectronNET.API/)
* CLI [![NuGet](https://img.shields.io/nuget/v/ElectronNET.CLI.svg?style=flat-square)](https://www.nuget.org/packages/ElectronNET.CLI/)
# Requirements to run:
The current Electron.NET CLI builds Windows 10/OSX/Ubuntu binaries. Our API uses .NET Core 2.0, so our minimum base OS is the same as [.NET Core 2](https://github.com/dotnet/core/blob/master/release-notes/2.0/2.0-supported-os.md).
# Usage:
To activate and communicate with the "native" (sort of native...) Electron API include the [ElectronNET.API NuGet package](https://www.nuget.org/packages/ElectronNET.API/) in your ASP.NET Core app.