MIT, better README

edspencer · Aug 24, 2024 · b7c17d0 · b7c17d0
1 parent 17b80a7
commit b7c17d0
Show file tree

Hide file tree

Showing 8 changed files with 238 additions and 304 deletions.
diff --git a/.changeset/real-tips-serve.md b/.changeset/real-tips-serve.md
@@ -0,0 +1,5 @@
+---
+"inform-ai": patch
+---
+
+Better README
diff --git a/.changeset/sharp-lies-build.md b/.changeset/sharp-lies-build.md
@@ -0,0 +1,5 @@
+---
+"inform-ai": minor
+---
+
+Adopt MIT license
diff --git a/README.md b/README.md
diff --git a/docs/current-state-example-2.png b/docs/current-state-example-2.png
diff --git a/docs/current-state-example.png b/docs/current-state-example.png
diff --git a/jest.config.ts b/jest.config.ts
@@ -1,12 +1,8 @@
-// jest.config.ts
 import type { JestConfigWithTsJest } from "ts-jest";
 
 const jestConfig: JestConfigWithTsJest = {
   preset: "ts-jest",
   testEnvironment: "jsdom",
-  transform: {
-    // "^.+\\.(t|j)sx?$": ["@swc/jest"],
-  },
   moduleNameMapper: {
     "^ai/rsc$": "<rootDir>/node_modules/ai/rsc/dist",
     "^@/(.*)$": "<rootDir>/$1",

diff --git a/package.json b/package.json
@@ -25,7 +25,7 @@
     "url": "git+https://github.com/edspencer/inform-ai.git"
   },
   "author": "Ed Spencer",
-  "license": "ISC",
+  "license": "MIT",
   "devDependencies": {
     "@changesets/cli": "^2.27.7",
     "@jest/globals": "^29.7.0",

diff --git a/src/ui/ChatWrapper.tsx b/src/ui/ChatWrapper.tsx
@@ -21,11 +21,10 @@ export interface ChatWrapperProps {
  *
  * import { ChatWrapper } from "inform-ai";
  * import { useActions, useUIState } from "ai/rsc";
- * import { AIProvider } from "./AI";
  *
  * export function MyCustomChatWrapper() {
  *   const { submitUserMessage } = useActions();
- *   const [messages, setMessages] = useUIState<typeof AIProvider>();
+ *   const [messages, setMessages] = useUIState();
  *
  *   return (
  *     <ChatWrapper
@@ -62,6 +61,7 @@ export interface ChatWrapperProps {
  *
  * function submitUserMessage() {
  *   //your implementation to send message to the LLM via Vercel AI SDK
+ *   //probably using the streamUI, streamText or similar functions
  * }
  *
  * export const AIProvider = createAI<AIState, UIState>({