From 36169d9a2c812c9f17cc1b88eff45e172a238a84 Mon Sep 17 00:00:00 2001 From: Jack Williams Date: Fri, 22 Nov 2024 17:23:01 +0000 Subject: [PATCH] Renamed GitHub repo and readme (#6) * Renamed GitHub repo * Basic README * late changesets * Create hot-kiwis-behave.md --- .changeset/hot-kiwis-behave.md | 5 ++++ README.md | 42 +++++++++++++++++++++++++++++++++- package.json | 4 ++-- 3 files changed, 48 insertions(+), 3 deletions(-) create mode 100644 .changeset/hot-kiwis-behave.md diff --git a/.changeset/hot-kiwis-behave.md b/.changeset/hot-kiwis-behave.md new file mode 100644 index 0000000..6690f4a --- /dev/null +++ b/.changeset/hot-kiwis-behave.md @@ -0,0 +1,5 @@ +--- +"@inngest/agent-kit": patch +--- + +Fix GitHub link and add `README.md` diff --git a/README.md b/README.md index 47f0d12..0bb0909 100644 --- a/README.md +++ b/README.md @@ -1 +1,41 @@ -# Agentkit +

+ Documentation +  ·  + Blog +  ·  + Community +

+ +# Agent kit + +`@inngest/agent-kit` lets developers build, test, and deploy reliable AI applications +at scale — from single model calls to multi-agent workflows that use tools. +Using the SDK lets you focus on AI code instead of technical details like +orchestration, state, or infrastructure. + +## Installation + +Agent kit requires the [Inngest TypeScript SDK](https://github.com/inngest/inngest-js) as a dependency. You can install both via `npm` or similar: + +```shell {{ title: "npm" }} +npm install @inngest/agent-kit inngest +``` + +## Documentation + +The full Agent kit documentation is available +[here](https://www.inngest.com/docs/agent-kit/overview). You can also jump to +specific guides and references: + +- [Agents and Tools](https://website-git-feat-ai-docs-post-inngest.vercel.app/docs/agent-kit/ai-agents-tools) +- [Network, state, and routing](https://website-git-feat-ai-docs-post-inngest.vercel.app/docs/agent-kit/ai-agent-network-state-routing) + +## Examples + +See Agent kit in action in fully functioning example projects: + +- [Test Writing Network](/demo#readme) - A ready-to-deploy Next.js demo using the Workflow Kit, Supabase, and OpenAI to power some AI content workflows. + +## License + +[Apache 2.0](LICENSE.md) diff --git a/package.json b/package.json index 92272ac..e4aaf82 100644 --- a/package.json +++ b/package.json @@ -12,10 +12,10 @@ "files": [ "dist" ], - "homepage": "https://github.com/inngest/agentkit", + "homepage": "https://github.com/inngest/agent-kit", "repository": { "type": "git", - "url": "git+https://github.com/inngest/agentkit.git" + "url": "git+https://github.com/inngest/agent-kit.git" }, "keywords": [ "inngest",