README.md in extism-1.0.0.pre.rc.5 vs README.md in extism-1.0.0
- old
+ new
@@ -1,11 +1,9 @@
# Extism Ruby Host SDK
This repo contains the ruby gem for integrating with the [Extism](https://extism.org/) runtime. Install this library into your host ruby application to run Extism plug-ins.
-> **Note**: This repo is 1.0 alpha version of the Ruby SDK and we may push breaking changes in between versions until we hit 1.0.0 in December, 2023. However, it is ready to use and you should use this if you're building a new integration. We'd love any feedback on it.
-
## Installation
### Install the Extism Runtime Dependency
For this library, you first need to install the Extism Runtime. You can [download the shared object directly from a release](https://github.com/extism/extism/releases) or use the [Extism CLI](https://github.com/extism/cli) to install it:
@@ -16,23 +14,21 @@
#=> Fetching https://github.com/extism/extism/releases/download/v0.5.2/libextism-aarch64-apple-darwin-v0.5.2.tar.gz
#=> Copying libextism.dylib to /usr/local/lib/libextism.dylib
#=> Copying extism.h to /usr/local/include/extism.h
```
-> **Note**: This library has breaking changes and targets 1.0 of the runtime. For the time being, install the runtime from our nightly development builds on git: `sudo extism lib install --version git`.
-
### Install the Gem
Add this library to your [Gemfile](https://bundler.io/):
```ruby
-gem 'extism', '1.0.0.pre.rc.5'
+gem 'extism', '~> 1.0.0'
```
Or if installing on the system level:
```
-gem install extism --pre
+gem install extism
```
## Getting Started
This guide should walk you through some of the concepts in Extism and this ruby library.