Skip to content

Commit

Permalink
Renamed GitHub repo and readme (#6)
Browse files Browse the repository at this point in the history
* Renamed GitHub repo

* Basic README

* late changesets

* Create hot-kiwis-behave.md
  • Loading branch information
jpwilliams authored Nov 22, 2024
1 parent 2a5c576 commit 36169d9
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 3 deletions.
5 changes: 5 additions & 0 deletions .changeset/hot-kiwis-behave.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@inngest/agent-kit": patch
---

Fix GitHub link and add `README.md`
42 changes: 41 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,41 @@
# Agentkit
<p align="center">
<a href="https://www.inngest.com/docs/agent-kit/overview?ref=github-agent-kit-readme">Documentation</a>
<span>&nbsp;·&nbsp;</span>
<a href="https://www.inngest.com/blog?ref=github-agent-kit-readme">Blog</a>
<span>&nbsp;·&nbsp;</span>
<a href="https://www.inngest.com/discord">Community</a>
</p>

# 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)
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 36169d9

Please sign in to comment.