Skip to content

Commit

Permalink
chore(doc): README.md: Add note about the stable v3.x and gi.ts v4.x …
Browse files Browse the repository at this point in the history
…versions
  • Loading branch information
JumpLink committed Jul 25, 2023
1 parent e67ebda commit b6523d2
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@

`ts-for-gir` is a robust [TypeScript](https://www.typescriptlang.org/) type definitions generator that improves the development experience of [GJS](https://gitlab.gnome.org/GNOME/gjs/) projects. It has been completely rewritten over time to provide a more complete and accurate TypeScript representation of the [GObject introspection](https://gi.readthedocs.io/en/latest/) interfaces. With `ts-for-gir`, developers can now benefit from TypeScript's strong typing and improved code navigation, making it easier to build robust and powerful applications with GJS.

# Branch "3.x" - Stable Version

You are on the `3.x` branch. This are the stable features of `ts-for-gir` v3.x with support for [GJS](https://gitlab.gnome.org/GNOME/gjs) and [node-gtk](https://github.com/romgrk/node-gtk) environments. Explore the 3.x branch to generate comprehensive TypeScript type definitions for GObject introspection modules. If you want to help us merge with [gi.ts](https://github.com/gjsify/gi.ts), check out v4.x on the `main` branch.

`main` branch: https://github.com/gjsify/ts-for-gir/tree/main
`3.x` branch: https://github.com/gjsify/ts-for-gir/tree/3.x

## Getting Started

Install the latest LTS version of Node.js. We recommend using [NVM](https://github.com/nvm-sh/nvm) for this purpose. After Node.js has been installed, `ts-for-gir` can be executed with the following command:
Expand Down
2 changes: 1 addition & 1 deletion types
Submodule types updated 3726 files

0 comments on commit b6523d2

Please sign in to comment.