fix: update readme

iggy-rs · Jul 4, 2024 · 263f271 · 263f271
1 parent 214240c
commit 263f271
Showing 1 changed file with 27 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,8  1,33 @@
 # iggy-bin
 
-iggy-bin is an unofficial node.js client for [iggy-rs](https://iggy.rs/)'s binary protocol, written with typescript. it currently only support tcp transport.
 iggy-bin is an unofficial node.js client for [iggy-rs](https://iggy.rs/)'s binary protocol, written with typescript. it currently only support tcp & tls transports.
 
-## howto
 diclaimer: although all iggy commands & basic client/stream are implemented this is still a WIP provided as is and has still a long way to go to be considered "battle tested".
 
 ## install
 
 ```
 $ npm i iggy-bin
 ```
 
 ## basic usage
 
 ```ts
 import { Client } from 'iggy-bin';
 
 const credentials = { username: 'iggy', password: 'iggy' };
 
 const c = new Client({
   transport: 'TCP',
   options: { port: 8090, host: '127.0.0.1' },
   credentials
 });
 
 const stats = await c.system.getStats();
 ```
 
 
 ## use sources
 
 ### Install
 ```