|
4 | 4 |
|
5 | 5 | [](https://github.com/chatman-media/telegram-badge/actions) |
6 | 6 | [](https://badge.fury.io/js/telegram-badge) |
| 7 | +[](https://www.npmjs.com/package/telegram-badge) |
| 8 | +[](https://bundlephobia.com/package/telegram-badge) |
7 | 9 | [](https://www.typescriptlang.org/) |
8 | 10 | [](https://opensource.org/licenses/MIT) |
| 11 | +[](https://github.com/chatman-media/telegram-badge) |
9 | 12 | [](https://dev.to/chatman-media/show-your-telegram-group-member-count-in-github-readme-46pl) |
10 | 13 | [](https://x.com/chatman_media/status/1947399700795244694) |
11 | 14 |
|
@@ -155,8 +158,77 @@ https://telegram-badge.vercel.app/api/telegram-badge?logo=false |
155 | 158 | - 🆓 Бесплатно на Vercel при обычной нагрузке |
156 | 159 | - 📡 Можно расширить до отображения активности / количества сообщений |
157 | 160 |
|
158 | | -⸻ |
| 161 | +## 🔧 Использование API |
159 | 162 |
|
160 | | -📜 Лицензия |
| 163 | +### Как npm пакет: |
161 | 164 |
|
162 | | -MIT |
| 165 | +```bash |
| 166 | +npm install telegram-badge |
| 167 | +``` |
| 168 | + |
| 169 | +```typescript |
| 170 | +import badgeHandler from 'telegram-badge'; |
| 171 | + |
| 172 | +// Используйте в вашей serverless функции |
| 173 | +export default badgeHandler; |
| 174 | +``` |
| 175 | + |
| 176 | +### Прямые вызовы API: |
| 177 | + |
| 178 | +```typescript |
| 179 | +GET /api/telegram-badge?style=flat&label=Участники&color=2AABEE&labelColor=555555 |
| 180 | +``` |
| 181 | +
|
| 182 | +## 🧪 Тестирование |
| 183 | +
|
| 184 | +Запустить тесты: |
| 185 | +
|
| 186 | +```bash |
| 187 | +npm test |
| 188 | +``` |
| 189 | +
|
| 190 | +Проверка типов: |
| 191 | +
|
| 192 | +```bash |
| 193 | +npm run type-check |
| 194 | +``` |
| 195 | +
|
| 196 | +Сборка проекта: |
| 197 | +
|
| 198 | +```bash |
| 199 | +npm run build |
| 200 | +``` |
| 201 | +
|
| 202 | +## Подписывайтесь |
| 203 | +
|
| 204 | +[](https://www.tiktok.com/@chatman.media) |
| 205 | +[](https://www.twitch.tv/chatman1984) |
| 206 | +[](https://www.youtube.com/@chatman-media) |
| 207 | +[](https://t.me/alexanderkireyev) |
| 208 | +[](https://x.com/chatman_media) |
| 209 | +
|
| 210 | +## История звёзд |
| 211 | +
|
| 212 | +<a href="https://www.star-history.com/#chatman-media/telegram-badge&Date"> |
| 213 | + <picture> |
| 214 | + <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=chatman-media/telegram-badge&type=Date&theme=dark" /> |
| 215 | + <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=chatman-media/telegram-badge&type=Date" /> |
| 216 | + <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=chatman-media/telegram-badge&type=Date" /> |
| 217 | + </picture> |
| 218 | +</a> |
| 219 | +
|
| 220 | +## 🤝 Внести вклад |
| 221 | +
|
| 222 | +1. Форкните репозиторий |
| 223 | +2. Создайте ветку для новой функции (`git checkout -b feature/amazing-feature`) |
| 224 | +3. Зафиксируйте изменения (`git commit -m 'Add some amazing feature'`) |
| 225 | +4. Отправьте ветку (`git push origin feature/amazing-feature`) |
| 226 | +5. Откройте Pull Request |
| 227 | +
|
| 228 | +## 📜 Лицензия |
| 229 | +
|
| 230 | +Этот проект лицензирован под лицензией MIT - подробности в файле [LICENSE](LICENSE). |
| 231 | +
|
| 232 | +--- |
| 233 | +
|
| 234 | +Сделано с ❤️ от [Chatman Media](https://github.com/chatman-media) |
0 commit comments