Skip to content

Commit 24fd9c3

Browse files
committed
Add badge to readme
1 parent ce46bc4 commit 24fd9c3

File tree

3 files changed

+34
-2
lines changed

3 files changed

+34
-2
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# AngularNodeGUI
22

3+
[![npm version](https://badge.fury.io/js/angular-nodegui.svg)](https://www.npmjs.com/package/angular-nodegui)
4+
35
Build performant, native and cross-platform desktop applications with Angular.🚀
46

57
Angular NodeGUI is powered by Angular 🅰️ and Qt5 💚 which makes it CPU and memory efficient as compared to other chromium based solutions like electron. Angular NodeGUI is essentially a Angular renderer for NodeGUI.

projects/angular-nodegui/README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,22 @@ Build performant, native and cross-platform desktop applications with Angular.
44

55
Angular NodeGUI is powered by Angular 🅰️ and Qt5 💚 which makes it CPU and memory efficient as compared to other chromium based solutions like electron. Angular NodeGUI is essentially a Angular renderer for NodeGUI.
66

7+
## Docs
8+
9+
Main docs: https://docs.nodegui.org
10+
11+
# Getting started
12+
13+
## Requirements
14+
15+
- CMake 3.1 and up
16+
- Make, GCC v7
17+
- NodeJS 12.x and up.
18+
19+
Setting up on [macOS](https://docs.nodegui.org/docs/guides/getting-started#setting-up-on-macos), [Windows](https://docs.nodegui.org/docs/guides/getting-started#setting-up-on-windows), [Linux](https://docs.nodegui.org/docs/guides/getting-started#setting-up-on-linux)
20+
21+
[Getting started](https://docs.nodegui.org/docs/guides/getting-started)
22+
723
## Easy start
824

925
```
@@ -13,4 +29,18 @@ npm start
1329

1430
## Demo
1531

16-
Coming soon..
32+
### Start app
33+
34+
[Link](https://github.com/irustm/angular-nodegui/tree/master/src/app)
35+
36+
<p align="center">
37+
<img src="https://raw.githubusercontent.com/irustm/angular-nodegui/master/demo/demo_app.png" width="350" title="angular nodegui demo">
38+
</p>
39+
40+
### Widget
41+
42+
[Link](https://github.com/irustm/angular-nodegui/tree/master/projects/weather-demo)
43+
44+
<p align="center">
45+
<img src="https://raw.githubusercontent.com/irustm/angular-nodegui/master/demo/demo_weather_widget.png" width="600" title="angular nodegui demo">
46+
</p>

projects/angular-nodegui/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "angular-nodegui",
3-
"version": "0.0.1",
3+
"version": "0.0.2",
44
"license": "MIT",
55
"repository": {
66
"type": "git",

0 commit comments

Comments
 (0)