Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(readme): actualize readme #102

Merged
merged 1 commit into from
Sep 30, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,20 @@

[node-badge]: https://img.shields.io/badge/Node-1f491f?logo=node.js&logoColor=339933

# @twa.js
# @tma.js

Mono-repository, containing all the packages, connected with comfortable and safe TypeScript
development on Telegram Mini Apps platform. To learn more, follow packages own documentations.

To learn more, visit platform [documentation](https://docs.twa.dev).
To learn more, visit platform [documentation](https://docs.telegram-mini-apps.com).

## Packages

### `@twa.js/bridge`
### `@tma.js/bridge`

[bridge-code]: packages/bridge

[bridge-docs]: https://docs.twa.dev/docs/libraries/twa-js-bridge
[bridge-docs]: https://docs.telegram-mini-apps.com/docs/libraries/tma-js-bridge

[![docs-badge]][bridge-docs]
[![code-badge]][bridge-code]
Expand All @@ -30,47 +30,47 @@ Package which provides utilities to simplify communication flow between frontend
applications. It also solves some across-platform data difference problems to protect developers
code and save their time.

### `@twa.js/init-data`
### `@tma.js/init-data`

[init-data-code]: packages/init-data

[init-data-docs]: https://docs.twa.dev/docs/libraries/twa-js-init-data
[init-data-docs]: https://docs.telegram-mini-apps.com/docs/libraries/tma-js-init-data

[![docs-badge]][init-data-docs]
[![code-badge]][init-data-code]

Package providing utilities connected with Telegram Mini Apps init data. It
allows init data validation and parse, works both in browser and NodeJS.

### `@twa.js/init-data-node` <sup>![node-badge]</sup>
### `@tma.js/init-data-node` <sup>![node-badge]</sup>

[init-data-node-code]: packages/init-data-node

[init-data-node-docs]: https://docs.twa.dev/docs/libraries/twa-js-init-data-node
[init-data-node-docs]: https://docs.telegram-mini-apps.com/docs/libraries/tma-js-init-data-node

[![docs-badge]][init-data-node-docs]
[![code-badge]][init-data-node-code]

Package providing utilities connected with Telegram Mini Apps init data. It
allows init data validation and parse, works both in browser and NodeJS.

### `@twa.js/sdk`
### `@tma.js/sdk`

[sdk-code]: packages/sdk

[sdk-docs]: https://docs.twa.dev/docs/libraries/twa-js-sdk
[sdk-docs]: https://docs.telegram-mini-apps.com/docs/libraries/tma-js-sdk

[![docs-badge]][sdk-docs]
[![code-badge]][sdk-code]

Made from scratch production-ready TypeScript Telegram Mini Apps Source Development Kit. It includes
all features provided by other packages extending them with intuitively clear functionality.

### `@twa.js/sdk-react` <sup>![react-badge]</sup>
### `@tma.js/sdk-react` <sup>![react-badge]</sup>

[sdk-react-code]: packages/sdk-react

[sdk-react-docs]: https://docs.twa.dev/docs/libraries/twa-js-sdk-react
[sdk-react-docs]: https://docs.telegram-mini-apps.com/docs/libraries/tma-js-sdk-react

[![docs-badge]][sdk-react-docs]
[![code-badge]][sdk-react-code]
Expand All @@ -79,14 +79,14 @@ React bindings for client SDK. Contains hooks, components and other
useful tools which allow usage of React along with Web Apps client SDK.
Tracks SDK components changes out of box.

### `@twa.js/sdk-solid` <sup>![solid-badge]</sup>
### `@tma.js/sdk-solid` <sup>![solid-badge]</sup>

[sdk-solid-code]: packages/sdk-solid

[sdk-solid-docs]: https://docs.twa.dev/docs/libraries/twa-js-sdk-solid
[sdk-solid-docs]: https://docs.telegram-mini-apps.com/docs/libraries/tma-js-sdk-solid

[![docs-badge]][sdk-react-docs]
[![code-badge]][sdk-react-code]
[![docs-badge]][sdk-solid-docs]
[![code-badge]][sdk-solid-code]

Solid JS bindings for client SDK. Provides signals, hooks and components to be used in Solid JS
application.