Skip to content

Commit 9129be2

Browse files
howethomasclaude
andcommitted
Update documentation for PyPI release
- Add PyPI, Python version, and license badges - Update installation instructions to use pip install from PyPI - Simplify Docker example to install from PyPI - Keep source installation instructions for development Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 9bf47ed commit 9129be2

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# vCon Telephony Adapters
22

3+
[![PyPI version](https://badge.fury.io/py/vcon-telephony-adapters.svg)](https://pypi.org/project/vcon-telephony-adapters/)
4+
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6+
37
A monorepo of webhook-based adapters that convert telephony platform recordings into vCon (Virtual Conversation) format and post them to a vCon conserver.
48

59
## Overview
@@ -39,21 +43,27 @@ vcon-telephony-adapters/
3943

4044
## Installation
4145

42-
### Prerequisites
46+
### From PyPI (Recommended)
47+
48+
```bash
49+
pip install vcon-telephony-adapters
50+
```
4351

44-
First, install the vcon library:
52+
You'll also need the vcon library:
4553

4654
```bash
4755
pip install git+https://github.com/vcon-dev/vcon-lib.git
4856
```
4957

50-
### Using pip
58+
### From Source
5159

5260
```bash
61+
git clone https://github.com/vcon-dev/vcon-telephony-adapters.git
62+
cd vcon-telephony-adapters
5363
pip install -e .
5464
```
5565

56-
### Development installation
66+
### Development Installation
5767

5868
```bash
5969
pip install -e ".[dev]"
@@ -493,11 +503,10 @@ To add support for a new telephony platform:
493503
FROM python:3.11-slim
494504

495505
WORKDIR /app
496-
COPY . .
497506

498-
# Install vcon library
507+
# Install from PyPI
508+
RUN pip install vcon-telephony-adapters
499509
RUN pip install git+https://github.com/vcon-dev/vcon-lib.git
500-
RUN pip install -e .
501510

502511
EXPOSE 8080
503512
CMD ["vcon-adapter", "twilio"]

0 commit comments

Comments
 (0)