Skip to content

Update readme for 1.0 #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bhelx merged 1 commit into from
Jan 8, 2024
Merged

Update readme for 1.0 #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ This repo contains the Python package for integrating with the
[Extism](https://extism.org/) Webassembly framework. Install this library into
your Python application host to run Extism WebAssembly guest plug-ins.

> **Note**: :warning: This repo is 1.0 alpha version of the Python SDK and is a work in
> progress. :warning:
>
> This is safe and recommended to use for a new integration, however we may
> push breaking changes until we hit 1.0 in December, 2023.

```python
import extism
import json
Expand All @@ -30,10 +24,10 @@ Install this package from [PyPI](https://pypi.org/project/extism/):

```shell
# using pip
$ pip install extism==1.0.0rc0 --pre
$ pip install extism==1.0.0

# using poetry
$ poetry add extism=^1.0.0rc0 --allow-prereleases
$ poetry add extism=^1.0.0
```

The `extism` package should install an appropriate `extism_sys` dependency
Expand Down