Skip to content

Commit 88f5995

Browse files
update
1 parent 042cd7e commit 88f5995

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,35 +19,35 @@ The CLI extensions hosts our toolset to build and start Electron.NET application
1919

2020
Well... there are lots of different approaches how to get a X-plat desktop app running. We thought it would be nice for .NET devs to use the ASP.NET Core environment and just embed it inside a pretty robust X-plat enviroment called Electron. Porting Electron to .NET is not a goal of this project, at least we don't have any clue how to do it. We just combine ASP.NET Core & Electron.
2121

22-
# 📦 NuGet:
22+
## 📦 NuGet:
2323

2424
* API [![NuGet](https://img.shields.io/nuget/v/ElectronNET.API.svg?style=flat-square)](https://www.nuget.org/packages/ElectronNET.API/)
2525
* CLI [![NuGet](https://img.shields.io/nuget/v/ElectronNET.CLI.svg?style=flat-square)](https://www.nuget.org/packages/ElectronNET.CLI/)
2626

27-
# 🛠 Requirements to run:
27+
## 🛠 Requirements to run:
2828

2929
The current Electron.NET CLI builds Windows/macOS/Linux binaries. Our API uses .NET Core 3.1, so our minimum base OS is the same as [.NET Core 3.1](https://github.com/dotnet/core/blob/master/release-notes/3.1/3.1-supported-os.md).
3030

3131
Also you should have installed:
3232

3333
* npm [contained in nodejs](https://nodejs.org)
3434

35-
# 💬 Community
35+
## 💬 Community
3636

3737
[![Gitter](https://badges.gitter.im/ElectronNET/community.svg)](https://gitter.im/ElectronNET/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
3838

39-
# 🙏 Donate
39+
## 🙏 Donate
4040

4141
We do this open source work in our free time. If you'd like us to invest more time on it, please [donate](https://donorbox.org/electron-net). Donation can be used to increase some issue priority. Thank you!
4242

43-
# 👩‍🏫 Usage
43+
## 👩‍🏫 Usage
4444

4545
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.
4646

4747
````
4848
PM> Install-Package ElectronNET.API
4949
````
50-
## Program.cs
50+
### Program.cs
5151

5252
You start Electron.NET up with an `UseElectron` WebHostBuilder-Extension.
5353

@@ -61,7 +61,7 @@ You start Electron.NET up with an `UseElectron` WebHostBuilder-Extension.
6161
});
6262
```
6363

64-
## Startup.cs
64+
### Startup.cs
6565

6666
Open the Electron Window in the Startup.cs file:
6767

@@ -151,38 +151,38 @@ The end result should be an electron app under your __/bin/desktop__ folder.
151151
### Note
152152
> macOS builds can't be created on Windows machines because they require symlinks that aren't supported on Windows (per [this Electron issue](https://github.com/electron-userland/electron-packager/issues/71)). macOS builds can be produced on either Linux or macOS machines.
153153
154-
# 👨‍💻 Authors
154+
## 👨‍💻 Authors
155155

156156
* **Gregor Biswanger** - (Microsoft MVP, Intel Black Belt and Intel Software Innovator) is a freelance lecturer, consultant, trainer, author and speaker. He is a consultant for large and medium-sized companies, organizations and agencies for software architecture, web- and cross-platform development. You can find Gregor often on the road attending or speaking at international conferences. - [Cross-Platform-Blog](http://www.cross-platform-blog.com) - Twitter [@BFreakout](https://www.twitter.com/BFreakout)
157157
* **Robert Muehsig** - Software Developer - from Dresden, Germany, now living & working in Switzerland. Microsoft MVP & Web Geek. - [codeinside Blog](https://blog.codeinside.eu) - Twitter [@robert0muehsig](https://twitter.com/robert0muehsig)
158158

159159
See also the list of [contributors](https://github.com/ElectronNET/Electron.NET/graphs/contributors) who participated in this project.
160160

161161

162-
# 🙋‍♀️🙋‍♂ Contributing
162+
## 🙋‍♀️🙋‍♂ Contributing
163163
Feel free to submit a pull request if you find any bugs (to see a list of active issues, visit the [Issues section](https://github.com/ElectronNET/Electron.NET/issues).
164164
Please make sure all commits are properly documented.
165165

166-
# 🧪 Working with this Repo
166+
## 🧪 Working with this Repo
167167

168168
This repository consists of the main parts (API & CLI) and it's own "playground" ASP.NET Core application. Both main parts produce local NuGet packages, that are versioned with 99.0.0. The first thing you will need is to run one of the buildAll scripts (.cmd for Windows, the other for macOS/Linux).
169169

170170
If you look for pure __[demo projects](https://github.com/ElectronNET)__ checkout the other repositories.
171171

172172
The problem working with this repository is, that NuGet has a pretty aggressive cache, see [here for further information](https://github.com/ElectronNET/Electron.NET/wiki).
173173

174-
# 🙏 Donate
174+
## 🙏 Donate
175175

176176
We do this open source work in our free time. If you'd like us to invest more time on it, please [donate](https://donorbox.org/electron-net). Donation can be used to increase some issue priority. Thank you!
177177

178-
# 🎉 License
178+
## 🎉 License
179179
MIT-licensed
180180

181181
**Enjoy!**
182182

183-
# 📝 Important notes
183+
## 📝 Important notes
184184

185-
## ElectronNET.API & ElectronNET.CLI Version 8.31.1
185+
### ElectronNET.API & ElectronNET.CLI Version 8.31.1
186186

187187
Make sure you also have the new Electron.NET API & CLI 8.31.1 version.
188188

@@ -229,7 +229,7 @@ dotnet tool update ElectronNET.CLI -g
229229
}
230230
```
231231

232-
## ElectronNET.CLI Version 0.0.9
232+
### ElectronNET.CLI Version 0.0.9
233233

234234
In the Version 0.0.9 the CLI was not a global tool and needed to be registred like this in the .csproj:
235235

@@ -252,7 +252,7 @@ If you still use this version you will need to invoke it like this:
252252
electronize ...
253253
```
254254

255-
## Node Integration
255+
### Node Integration
256256
Electron.NET requires Node Integration to be enabled for IPC to function. If you are not using the IPC functionality you can disable Node Integration like so:
257257

258258
```csharp

0 commit comments

Comments
 (0)