Skip to content

Commit 85828cf

Browse files
Update README.md for public release
1 parent a05bd0f commit 85828cf

1 file changed

Lines changed: 6 additions & 8 deletions

File tree

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div align="center">
2-
<img src="./docs/images/logo-lightmode.svg#gh-light-mode-only" width="400" />
3-
<img src="./docs/images/logo-darkmode.svg#gh-dark-mode-only" width="400" />
2+
<img src="https://github.com/SWR-MoIP/VideoIPath-Automation-Tool/tree/main/docs/images/logo-lightmode.svg#gh-light-mode-only" width="400" />
3+
<img src="https://github.com/SWR-MoIP/VideoIPath-Automation-Tool/tree/main/docs/images/logo-darkmode.svg#gh-dark-mode-only" width="400" />
44
</div>
55

66
<p align="center">A <a href="https://www.python.org" target="_blank" rel="noopener noreferrer">Python</a> package for automating <a href="https://nevion.com/videoipath" target="_blank" rel="noopener noreferrer">VideoIPath</a> configuration workflows.</p>
@@ -34,14 +34,12 @@ The provided methods and data models ensure easy handling, robust validation, co
3434

3535
### Installation
3636

37-
Since the repository is currently private, the package must be downloaded manually as a build artifact from the [GitHub Releases section](https://github.com/SWR-MoIP/VideoIPath-Automation-Tool/releases).
38-
39-
Once the repository is public, the package will be available via the public PyPI registry for easy installation.
37+
The package is available via the [Python Package Index (PyPI)](https://pypi.org/project/videoipath-automation-tool/) and can be installed directly using `pip`.
4038

4139
#### Install the package using pip
4240

4341
```bash
44-
pip3 install "path/to/downloads/videoipath_automation_tool-0.1.2.tar.gz"
42+
pip3 install videoipath-automation-tool
4543
```
4644

4745
### A Simple Example: Adding a Device to the Inventory
@@ -90,7 +88,7 @@ Your feedback and contributions are highly appreciated! There are several ways t
9088
</p>
9189

9290
<p>
93-
✅ <strong>[After release] Contribute via pull requests:</strong> If you want to implement a fix or a new feature yourself, feel free to fork the repository and submit a pull request.
91+
✅ <strong>Contribute via pull requests:</strong> If you want to implement a fix or a new feature yourself, feel free to fork the repository and submit a pull request.
9492
➝ <a href="https://github.com/SWR-MoIP/VideoIPath-Automation-Tool/fork">Fork the Repository</a>
9593
</p>
9694

@@ -103,7 +101,7 @@ Thank you for your support and contributions!
103101

104102
## Disclaimer
105103

106-
_"VideoIPath Automation Tool"_ is an independent software tool that can be used with the [VideoIPath](https://nevion.com/videoipath) media orchestration platform. However, it is not a product or service offered by Nevion, and Nevion is not responsible for its functionality, performance, support, or any unforeseen consequences arising from its use. Nevion's VideoIPath platform is used to manage critical media infrastructure, and special care is advised concerning the use of external tools such as this.
104+
VideoIPath Automation Tool is an independent software tool that can be used with the [VideoIPath](https://nevion.com/videoipath) media orchestration platform. However, it is not a product or service offered by Nevion, and Nevion is not responsible for its functionality, performance, support, or any unforeseen consequences arising from its use. Nevion's VideoIPath platform is used to manage critical media infrastructure, and special care is advised concerning the use of external tools such as this.
107105

108106
## License
109107

0 commit comments

Comments
 (0)