Skip to content

Commit 7ca3708

Browse files
docs: updated README to reflect recent project changes
1 parent bfaa148 commit 7ca3708

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,13 @@
88
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
99
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
1010

11-
A Python package for rendering protein structures of PDB format in 3D using [Ursina](https://www.ursinaengine.org/).
11+
A Python package for rendering protein structures of PDB format in 3D using [Ursina](https://www.ursinaengine.org/), as featured in [Ursina's sample projects](https://www.ursinaengine.org/samples.html).
1212

1313
![Example proteins](./assets/example.png)
1414

1515
## Installation
16-
To install the library locally, clone the repo down and install dependencies with [Poetry](https://python-poetry.org/).
16+
The package is published on [PyPI](https://pypi.org/project/ursina-proteins/), and can be installed with `pip install ursina-proteins`.
17+
You can also clone the repo down and install dependencies with [Poetry](https://python-poetry.org/).
1718
```bash
1819
# Clone the repo
1920
git clone https://github.com/HarrisonTCodes/ursina-proteins.git
@@ -24,13 +25,13 @@ poetry install
2425
```
2526

2627
## Usage
27-
You can use the library in an existing Ursina project by importing the Protein class and creating an instance from a PDB file. You can render any proteins in the PDB file format, and can find many available for download at the [RCSB Protein Data Bank](https://www.rcsb.org/).
28+
You can use the library in an existing Ursina project by importing the `Protein` class and creating an instance from a PDB file. You can render any proteins in the PDB file format, and can find many available for download at the [RCSB Protein Data Bank](https://www.rcsb.org/).
2829
```python
2930
from ursina_proteins.protein import Protein
3031

3132
Protein("/path/to/file.pdb")
3233
```
33-
You can also test the library out by running `demo.py`. This script renders a simple scene with an example protein ([insulin](https://www.rcsb.org/structure/3I40)).
34+
You can also test the library out by running [demo.py](https://github.com/HarrisonTCodes/ursina-proteins/blob/main/src/demo.py). This script renders a simple scene with an example protein ([insulin](https://www.rcsb.org/structure/3I40)).
3435
```bash
3536
poetry run python src/demo.py
3637
```

0 commit comments

Comments
 (0)