Skip to content

Commit

Permalink
README.md: Add ts-for-gir style header
Browse files Browse the repository at this point in the history
  • Loading branch information
JumpLink committed Apr 2, 2024
1 parent c018792 commit b29fccb
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 3 deletions.
Binary file added .github/avatar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/avatar_x8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 Pascal Garber
Copyright (c) 2023-2024 Pascal Garber

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
# GNOME Shell Type Definitions
<p align="center">
<img src="https://raw.githubusercontent.com/gjsify/gnome-shell/main/.github/avatar_x8.png" />
<h1 align="center">TypeScript <small>for</small> GNOME Shell</h1>
</p>

<p align="center">
<a href="https://github.com/gjsify/gnome-shell/actions"><img src="https://img.shields.io/github/actions/workflow/status/gjsify/gnome-shell/ci.yml" /></a>
<a href="https://github.com/gjsify/gnome-shell/blob/main/LICENSE"><img src="https://img.shields.io/github/license/gjsify/gnome-shell" /></a>
<a href="https://www.npmjs.com/package/@girs/gnome-shell"><img src="https://img.shields.io/npm/v/@girs/gnome-shell" /></a>
<a href="https://www.npmjs.com/package/@girs/gnome-shell"><img src="https://img.shields.io/npm/dw/@girs/gnome-shell" /></a>
</p>

<p align="center">Write GNOME Shell Extensions in TypeScript</p>

## Overview
This project provides TypeScript type definitions for GNOME Shell Extensions. It aims to make the development of GNOME Shell Extensions in TypeScript more intuitive and efficient. The project is currently in an experimental phase and greatly benefits from community contributions.
Expand Down
14 changes: 13 additions & 1 deletion packages/gnome-shell/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
# GNOME Shell TypeScript Type Definitions
<p align="center">
<img src="https://raw.githubusercontent.com/gjsify/gnome-shell/main/.github/avatar_x8.png" />
<h1 align="center">TypeScript <small>for</small> GNOME Shell</h1>
</p>

<p align="center">
<a href="https://github.com/gjsify/gnome-shell/actions"><img src="https://img.shields.io/github/actions/workflow/status/gjsify/gnome-shell/ci.yml" /></a>
<a href="https://github.com/gjsify/gnome-shell/blob/main/LICENSE"><img src="https://img.shields.io/github/license/gjsify/gnome-shell" /></a>
<a href="https://www.npmjs.com/package/@girs/gnome-shell"><img src="https://img.shields.io/npm/v/@girs/gnome-shell" /></a>
<a href="https://www.npmjs.com/package/@girs/gnome-shell"><img src="https://img.shields.io/npm/dw/@girs/gnome-shell" /></a>
</p>

<p align="center">Write GNOME Shell Extensions in TypeScript</p>

## Overview
This NPM package, `@girs/gnome-shell`, provides TypeScript type definitions for developing GNOME Shell Extensions. It is tailored to enhance the development experience for those using TypeScript. The types are currently in an experimental phase, and community contributions play a significant role in their refinement and expansion.
Expand Down

0 comments on commit b29fccb

Please sign in to comment.