Skip to content
This repository was archived by the owner on Mar 18, 2025. It is now read-only.

Commit dc10de4

Browse files
committed
feat: Link docs in readme
1 parent 74e7f30 commit dc10de4

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Readme.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Svelte NodeGUI is powered by **Svelte** and **Qt5** 💚 which makes it CPU and
1515

1616
<img src="https://vuejs.org/images/logo.png" alt="" width="25" /> If you are looking for the **Vue**-based version, check out: **[Vue NodeGUI](https://github.com/nodegui/vue-nodegui)**.
1717

18-
There is no dedicated documentation for Svelte NodeGUI yet, so please refer to the [React NodeGui](https://react.nodegui.org/) documentation website instead. Svelte NodeGUI implements exactly the same APIs as React NodeGUI – literally a copy-paste, as you'll see in [src/dom/react-nodegui](src/dom/react-nodegui) – so those docs are equally applicable.
18+
Visit: https://svelte.nodegui.org for docs.
1919

2020
<img alt="logo" src="https://github.com/nodegui/nodegui/raw/master/extras/logo/nodegui.png" height="200" />
2121

@@ -40,10 +40,10 @@ https://github.com/nodegui/examples
4040

4141
## Features
4242

43-
- 🧬 Cross platform. Should work on major Linux flavours, Windows and MacOS.
43+
- 🧬 Cross platform. Should work on major Linux flavours, Windows and macOS.
4444
- 📉 Low CPU and memory footprint. Current CPU stays at 0% on idle and memory usage is under 20mb for a hello world program.
4545
- 💅 Styling with CSS (includes actual cascading). Also has full support for Flexbox layout (thanks to Yoga).
46-
- ✅ Complete Nodejs api support (Currently runs on Node v12.x - and is easily upgradable). Hence has access to all nodejs compatible npm modules.
46+
- ✅ Complete Node.js api support (Currently runs on Node v12.x - and is easily upgradable). Hence has access to all Node.js-compatible npm modules.
4747
- 🎪 Native widget event listener support. Supports all events available from Qt / NodeJs.
4848
- 💸 Can be used for Commercial applications.
4949
- 🕵️‍♂️ Good Devtools support.
@@ -55,7 +55,7 @@ https://github.com/nodegui/examples
5555
## Getting Started
5656

5757
- For now, download a zip of this repo and copying the `demo` folder is the best way to scaffold a new project.
58-
- Read through the [React NodeGUI docs](https://react.nodegui.org/) (there are no Svelte NodeGui docs yet, but there should be little difference).
58+
- Read through the [Svelte NodeGUI docs](https://svelte.nodegui.org/) (there are no Svelte NodeGUI docs yet, but there should be little difference).
5959
- Checkout the examples: https://github.com/nodegui/examples .
6060
- [Tutorial: Build a native Meme Search Desktop app with Javascript (NodeGUI) and Giphy API](https://www.sitepoint.com/build-native-desktop-gif-searcher-app-using-nodegui/)
6161

0 commit comments

Comments
 (0)