mascully/nu_plugin_ws
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Create README

Browse source 
Signed-off-by: Alex Kattathra Johnson <alex.kattathra.johnson@gmail.com>
This commit is contained in:
Alex Kattathra Johnson 2024-12-06 13:08:56 -06:00
parent 0f9fa4aa66
commit c47b991cbb
No known key found for this signature in database
GPG key ID: 64BCC76905798553
1 changed files with 39 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -0,0 +1,39 @@
# nu_plugin_ws
[![Crates.io Version](https://img.shields.io/crates/v/nu_plugin_ws)](https://crates.io/crates/nu_plugin_ws)
[![Nushell](https://img.shields.io/badge/Nushell-v0.99.1-blue)](https://nushell.sh)
A plugin for [Nushell](https://nushell.sh), a cross-platform shell and scripting language. This plugin adds support for
streaming from a websocket.
## Installation
### Cargo
Get the latest version from [crates.io](https://crates.io/crates/nu_plugin_ws) with a local install:
```bash
# Downloads and installs the plugin
cargo install nu_plugin_ws
# Registers the plugin with Nushell
plugin add ~/.cargo/bin/nu_plugin_ws
# Activates the plugin
plugin use ws
```
### Manual build
Manual builds can also be used:
```bash
# Clone the repository
git clone https://github.com/alex-kattathra-johnson/nu_plugin_ws.git
# Enter the repo folder
cd nu_plugin_ws
# Build a release version of the plugin
cargo build -r
# Registers the plugin with Nushell
plugin add target/release/nu_plugin_ws
# Activates the plugin
plugin use ws
```