Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
poulad committed Sep 7, 2018
1 parent 5b55f71 commit b2df0be
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
# Passport Extension for Telegram Bot API Client
# Telegram Passport

[![package](https://img.shields.io/nuget/v/Telegram.Bot.Extensions.Passport.svg?style=flat-square)](https://www.nuget.org/packages/Telegram.Bot.Extensions.Passport)
[![build](https://img.shields.io/appveyor/tests/pouladpld/telegram-bot-extensions-passport/master.svg?style=flat-square)](https://ci.appveyor.com/project/pouladpld/telegram-bot-extensions-passport)
[![documentations](https://img.shields.io/badge/docs-book-orange.svg?style=flat-square)](https://telegrambots.github.io/book/4/passport)

This project is an extension to [Telegram.Bot] package for supporting [Telegram Passport] feature.
You need to add `Telegram.Bot.Extensions.Passport` extension package to your project
in addition to the core package (`Telegram.Bot`).

```bash
dotnet add package Telegram.Bot.Extensions.Passport
```

## Documentation
## 📖 Documentation

You can find documentation for this project in [Telegram Bots Book].
You can find documentation for this project including the quickstart guide in [Telegram Bots Book].

## Build
## 🔨 Build & Contribute 👋

```bash
# ensure sub modules are updated
Expand All @@ -19,4 +29,4 @@ git checkout ext-passport

[Telegram.Bot]: https://github.com/TelegramBots/Telegram.Bot
[Telegram Passport]: https://telegram.org/blog/passport
[Telegram Bots Book]: https://telegrambots.github.io/book
[Telegram Bots Book]: https://telegrambots.github.io/book/4/passport

0 comments on commit b2df0be

Please sign in to comment.