Skip to content

Commit 237557c

Browse files
committed
Update package readme and package.json
1 parent beaf0f2 commit 237557c

File tree

3 files changed

+16
-3
lines changed

3 files changed

+16
-3
lines changed

.editorconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ charset = utf-8
1111

1212
[*.md]
1313
indent_style = space
14-
indent_size = 4
14+
indent_size = 2
1515
insert_final_newline = true
1616
trim_trailing_whitespace = true
1717
end_of_line = lf
+10-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
1-
# Partial AI Stream Library
1+
# OpenaAI Partial Stream Library
22

3-
Turn a stream of token into a parsable JSON object as soon as possible.
3+
- Convert a **stream of token** into a **parsable JSON** object before the stream ends.
4+
- Implement **Streaming UI** in **LLM**-based AI application.
5+
- Leverage **OpenAI Function Calling** for early stream processing.
6+
- Parse **JSON stream** into distinct **entities**.
7+
- Engage your users with a **real-time** experience.
48

59
## Installation
610

711
```bash
812
npm install openai-partial-stream
913
```
14+
15+
# Usage Example on GitHub
16+
17+
- [GitHub repo](https://github.com/st3w4r/partial-stream)

packages/openai-partial-stream/package.json

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
"license": "MIT",
55
"private": false,
66
"version": "0.3.4",
7+
"repository": {
8+
"type": "git",
9+
"url": "https://github.com/st3w4r/partial-stream.git",
10+
"directory": "packages/openai-partial-stream"
11+
},
712
"devDependencies": {
813
"@jest/globals": "^29.7.0",
914
"@types/jest": "^29.5.5",

0 commit comments

Comments
 (0)