Update docs (#1)

* update README

* Update package.json

README.md

@@ -3,7 +3,11 @@
 [![Build Status](https://github.com/extremeheat/LXL/actions/workflows/ci.yml/badge.svg)](https://github.com/extremeheat/LXL/actions/workflows/)
 [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/extremeheat/LXL)
 
-LangXLang (LXL), a simple wrapper for Node.js and OpenAI's GPT and Google PaLM 2 LLMs.
+LangXLang (LXL), a simple wrapper for Node.js to use OpenAI's GPT models and Google's Gemini and PaLM 2 models.
+
+Supported models are:
+* OpenAI: `gpt-3.5-turbo-16k`, `gpt-3.5-turbo`, `gpt-4`, `gpt-4-turbo-preview`
+* Google: `gemini-1.0-pro` (Gemini), or `text-bison-001`, `text-bison-002`, `palm-2` (PaLM 2)
 
 Work in progress, not ready for use.
 
@@ -19,22 +23,22 @@ See tests/ for examples.
 
 ## API
 
-### `CompletionService`
+### CompletionService
 
-#### `constructor(apiKeys: { openai: string, gemini: string })`
+#### constructor(apiKeys: { openai: string, gemini: string })
 
 Creates an instance of completion service.
 Note: as an alternative to explicitly passing the API keys in the constructor you can: 
 * set the `OPENAI_API_KEY` and `GEMINI_API_KEY` environment variables.
 * or, define the keys inside `/.local/share/lxl-cache.json` (linux), `~/Library/Application Support/lxl-cache.json` (mac), or `%appdata%\lxl-cache.json` (windows).
 
-#### async `requestCompletion(model: string, systemPrompt: string, userPrompt: string)`
+#### async requestCompletion(model: string, systemPrompt: string, userPrompt: string)
 
 Request a non-streaming completion from the model.
 
-### `ChatSession`
+### ChatSession
 
-### `constructor(completionService: CompletionService, model: string, systemPrompt: string)`
+### constructor(completionService: CompletionService, model: string, systemPrompt: string)
 
 ChatSession is for back and forth conversation between a user an an LLM.
 

package.json

@@ -1,8 +1,9 @@
 {
   "name": "langxlang",
   "version": "0.1.0",
-  "description": "OpenAI GPT and Google PaLM 2 LLM wrapper",
+  "description": "LLM wrapper for OpenAI GPT and Google Gemini and PaLM 2 models",
   "main": "src/index.js",
+  "types": "src/index.d.ts",
   "scripts": {
     "test": "",
     "pretest": "npm run lint",
@@ -13,7 +14,7 @@
     "type": "git",
     "url": "git+https://github.com/extremeheat/LXL.git"
   },
-  "keywords": [],
+  "keywords": ["gpt", "openai", "gemini", "palm", "chat", "ai", "ml"],
   "author": "extremeheat",
   "license": "MIT",
   "bugs": {

test/basic.test.js

@@ -2,6 +2,6 @@
 
 describe('basic', () => {
   it('test', () => {
-    console.log('it works~')
+    console.log('please manually run test in api.js')
   })
 })