Skip to content

Commit 47a8798

Browse files
committed
feat: add readme text
1 parent 529cde5 commit 47a8798

1 file changed

Lines changed: 24 additions & 1 deletion

File tree

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<br />
22
<p align="center">
3-
<a><img src="image/contextplus-circle.png" alt="ContextPlus" width="128" height="128" title="FawnRescue"></a>
3+
<a><img src="https://raw.githubusercontent.com/Multi-Agent-LLMs/context-plus/main/image/contextplus-circle.png?token=GHSAT0AAAAAACRDJ47UT64OBP3RQ372AGN2ZR2FGSQ" alt="ContextPlus" width="128" height="128" title="FawnRescue"></a>
44
<h3 align="center">ContextPlus</h3>
55
<p align="center">
66
Empowering Conversations with Real-Time Facts<br />
@@ -16,3 +16,26 @@
1616
</p>
1717
</p>
1818
</p>
19+
20+
## Overview
21+
**ContextPlus** is a Python library designed to enhance conversations by providing real-time facts and information using large language models (LLMs). It operates completely on the CPU, making it accessible for integration into various applications without the need for specialized hardware.
22+
23+
## Installation
24+
25+
To install ContextPlus, use the following pip command:
26+
27+
```bash
28+
pip install contextplus
29+
```
30+
31+
## Usage
32+
33+
Import and use the `context` function from the `contextplus` library to integrate real-time factual data into your projects:
34+
35+
```python
36+
from contextplus import context
37+
38+
# Example usage
39+
response = context("What is a LLM?")
40+
print(response)
41+
```

0 commit comments

Comments
 (0)