Skip to content

Commit

Permalink
Added Usage guide
Browse files Browse the repository at this point in the history
  • Loading branch information
erfanmola committed Oct 6, 2023
1 parent 346419f commit 3481f9c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,17 @@ TeleVue is a simple lightweight UI library for [Telegram Web Apps](https://core.
## Installation
You can simply use NPM to install TeleVue package in your Vue project.
```
yarn add @erfanmola/TeleVue
npm install @erfanmola/TeleVue
```

## Usage
Inside your vue projects, you can import any provider/component that you want, but keep in mind that you must import the `style.css` file separately. For example:
```
import { AppearanceProvider, LocaleProvider } from 'tele-vue-lib';
import 'tele-vue-lib/style.css';
```

## Motivation
Telegram expanded it's field by introducing the WebApps built-in the messenger. Soon after developers started developing their own useful WebApps as Telegram Web Apps, but this introduced the problem of unfitting appearances of most WebApps on Telegram clients, since Telegram supports different themes and color schemes (Dark, Light) on different platforms (Android, iOS, Desktop, etc)

Expand Down

0 comments on commit 3481f9c

Please sign in to comment.