How to instructions update

#1
by rmcnairn - opened
Files changed (1) hide show
  1. README.md +14 -1
README.md CHANGED
@@ -3,4 +3,17 @@ license: mit
3
  language:
4
  - en
5
  ---
6
- This is a simple package wrapping llama-index CLI with Wordsmith defaults for a "Hello World" interaction with RAG.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3
  language:
4
  - en
5
  ---
6
+ This is a simple package wrapping llama-index CLI with Wordsmith defaults for a "Hello World" interaction with RAG.
7
+
8
+ Step 1:
9
+ pip install git+https://huggingface.co/derek-at-work/hello_wordsmith -q // This is a simple wrapper around llama index, that helps you to get up and running with a basic data set and will help you clone the key aspects you need
10
+
11
+ Step 2:
12
+ export OPENAI_API_KEY="sk-XXX-OPENAI-API-KEY-XXX" // replace the placeholder text with your API key
13
+
14
+ Step 3:
15
+ Interacting with your command line RAG pipeline:
16
+ hello-wordsmith // launch a chat or hello-wordsmith -q 'What is RAG?' // to ask a one-off
17
+
18
+ Index additional data:
19
+ You can load in your own data to chat with hello-wordsmith -f "./my_directory/*" It's stored locally and can be wiped with hello-wordsmith --clear