Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
heyqbnk authored Oct 8, 2024
1 parent 1167f34 commit d2f588c
Showing 1 changed file with 12 additions and 90 deletions.
102 changes: 12 additions & 90 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,100 +5,22 @@
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

Mono-repository, containing all the packages, connected with comfortable and safe TypeScript
development on Telegram Mini Apps platform. To learn more about specific packages, follow
their own [documentations](https://docs.telegram-mini-apps.com).
development on Telegram Mini Apps platform.

> [!WARNING]
> Working with @telegram-apps packages, you must not install the SDK from Telegram presented by
> a single file - telegram-web-app.js. Using both @telegram-apps packages and telegram-web-app.js
> will surely lead to bugs.
## Packages

[docs-badge]: https://img.shields.io/badge/documentation-a?logo=gitbook&logoColor=white&color=%23007AFF

### `@telegram-apps/sdk`

[sdk-npm-badge]: https://img.shields.io/npm/v/@telegram-apps/sdk?logo=npm

[![docs-badge]](https://docs.telegram-mini-apps.com/packages/telegram-apps-sdk)
[![sdk-npm-badge]](https://npmjs.com/package/@telegram-apps/sdk)
![Size](https://img.shields.io/bundlephobia/minzip/@telegram-apps/sdk)
[![code-badge]](https://github.com/Telegram-Mini-Apps/telegram-apps/tree/master/packages/sdk)

Made from scratch TypeScript library for seamless communication with Telegram Mini Apps
functionality.

The code of this library is designed to simplify the process of developers interacting with Telegram
Mini Apps. It consists of several individual components, each responsible for a specific aspect of
the Telegram Mini Apps ecosystem.

Before you begin using the SDK, we highly recommend familiarizing yourself with the Telegram Mini
Apps [documentation](https://docs.telegram-mini-apps.com/platform/about)
to grasp the fundamental concepts of the platform.

### `@telegram-apps/sdk-react`

[sdk-react-npm-badge]: https://img.shields.io/npm/v/@telegram-apps/sdk-react?logo=npm

[![docs-badge]](https://docs.telegram-mini-apps.com/packages/telegram-apps-sdk-react)
[![sdk-react-npm-badge]](https://npmjs.com/package/@telegram-apps/sdk-react)
![Size](https://img.shields.io/bundlephobia/minzip/@telegram-apps/sdk-react)
[![code-badge]](https://github.com/Telegram-Mini-Apps/telegram-apps/tree/master/packages/sdk-react)

React JS bindings for [client SDK](https://docs.telegram-mini-apps.com/packages/telegram-apps-sdk). Includes
hooks, components and utilities for comfortable usage of React JS on the Telegram Mini Apps platform.

### `@telegram-apps/sdk-solid`
## Getting Started

[sdk-solid-npm-badge]: https://img.shields.io/npm/v/@telegram-apps/sdk-solid?logo=npm
A great starting point for learning about the platform is the community-built [documentation](https://docs.telegram-mini-apps.com).
Additionally, the official Telegram [platform documentation](https://core.telegram.org/bots/webapps) can
provide valuable insights and a different perspective on the platform.

[![docs-badge]](https://docs.telegram-mini-apps.com/packages/telegram-apps-sdk-solid)
[![sdk-solid-npm-badge]](https://npmjs.com/package/@telegram-apps/sdk-solid)
![Size](https://img.shields.io/bundlephobia/minzip/@telegram-apps/sdk-solid)
[![code-badge]](https://github.com/Telegram-Mini-Apps/telegram-apps/tree/master/packages/sdk-solid)
Before diving into development, it’s also advisable to explore the available
[libraries](https://docs.telegram-mini-apps.com/packages/telegram-apps-create-mini-app) for
both client-side and backend development to gain a better understanding of the tools at your
disposal.

Solid JS bindings
for [client SDK](https://docs.telegram-mini-apps.com/packages/telegram-apps-sdk). Includes
hooks, components and utilities
for comfortable usage of Solid JS on the Telegram Mini Apps platform.

### `@telegram-apps/init-data-node`

[init-data-node-npm-badge]: https://img.shields.io/npm/v/@telegram-apps/init-data-node?logo=npm

[![docs-badge]](https://docs.telegram-mini-apps.com/packages/telegram-apps-init-data-node)
[![init-data-node-npm-badge]](https://npmjs.com/package/@telegram-apps/init-data-node)
![Size](https://img.shields.io/bundlephobia/minzip/@telegram-apps/init-data-node)
[![code-badge]](https://github.com/Telegram-Mini-Apps/telegram-apps/tree/master/packages/init-data-node)

The package provides utilities to work with the initialization data of Telegram Mini Apps on the
server side. To learn more about the initialization data and its usage, please refer to
the [documentation](https://docs.telegram-mini-apps.com/platform/launch-parameters).

### `@telegram-apps/solid-router-integration`

[solid-router-integration-npm-badge]: https://img.shields.io/npm/v/@telegram-apps/solid-router-integration?logo=npm

[![docs-badge]](https://docs.telegram-mini-apps.com/packages/telegram-apps-solid-router-integration)
[![solid-router-integration-npm-badge]](https://npmjs.com/package/@telegram-apps/solid-router-integration)
![Size](https://img.shields.io/bundlephobia/minzip/@telegram-apps/solid-router-integration)
[![code-badge]](https://github.com/Telegram-Mini-Apps/telegram-apps/tree/master/packages/solid-router-integration)

Telegram Mini Apps [Navigator](https://docs.telegram-mini-apps.com/packages/telegram-apps-sdk/navigation)
integration for [@solidjs/router](https://www.npmjs.com/package/@solidjs/router).

### `@telegram-apps/react-router-integration`

[react-router-integration-npm-badge]: https://img.shields.io/npm/v/@telegram-apps/react-router-integration?logo=npm

[![docs-badge]](https://docs.telegram-mini-apps.com/packages/telegram-apps-react-router-integration)
[![react-router-integration-npm-badge]](https://npmjs.com/package/@telegram-apps/react-router-integration)
![Size](https://img.shields.io/bundlephobia/minzip/@telegram-apps/react-router-integration)
[![code-badge]](https://github.com/Telegram-Mini-Apps/telegram-apps/tree/master/packages/react-router-integration)

Telegram Mini Apps [Navigator](https://docs.telegram-mini-apps.com/packages/telegram-apps-sdk/navigation)
integration for [react-router-dom](https://www.npmjs.com/package/react-router-dom).
> [!WARNING]
> Working with `@telegram-apps` packages, you <ins>**must not**</ins> use the Telegram library - `telegram-web-app.js`.
> Using both `@telegram-apps` packages and `telegram-web-app.js` will surely lead to bugs.
## Why not Telegram SDK

Expand Down

0 comments on commit d2f588c

Please sign in to comment.