Skip to content

Commit 3f5346e

Browse files
committed
update readme for correct usage + publishing guidance
1 parent bc5fea3 commit 3f5346e

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,14 +82,19 @@ engine = Engine(...)
8282
storage = Storage(secret_key=...)
8383

8484
# Example: Create tools for AI agents
85+
# Option 1: Use Nebula alone (recommended when you need a self-sufficient blockchain agent)
86+
# Nebula already uses most other services internally
8587
tools = [
86-
*insight.get_tools(),
8788
*nebula.get_tools(),
88-
*engine.get_tools(),
89-
*storage.get_tools(),
90-
# Or pick an individual tool from the services
9189
]
9290

91+
# Option 2: Use individual services directly without Nebula
92+
# tools = [
93+
# *insight.get_tools(),
94+
# *engine.get_tools(),
95+
# *storage.get_tools(),
96+
# ]
97+
9398
# Example: Framework integration (LangChain)
9499
from thirdweb_ai.adapters.langchain import get_langchain_tools
95100
langchain_tools = get_langchain_tools(tools)
@@ -121,6 +126,19 @@ We take security seriously. If you discover a security vulnerability within thir
121126

122127
For non-security-related bugs, please use the GitHub issue tracker.
123128

129+
## ⚠️ Important Usage Notes
130+
131+
When using Nebula, do not combine it with other tools (Insight, Engine, Storage) in the same agent implementation as Nebula already calls these tools in the background. Using them together can lead to compatibility issues and unexpected behavior.
132+
133+
## 📦 Publishing Workflow
134+
135+
To publish a new version of thirdweb AI packages:
136+
137+
1. Create a git tag for the new version: `git tag -a v0.X.Y -m "Release v0.X.Y"`
138+
2. Push the tag to GitHub: `git push origin v0.X.Y`
139+
3. Go to GitHub and create a release using this tag
140+
4. The CI/CD pipeline will automatically build and publish both packages to PyPI with matching version numbers
141+
124142
## 📧 Contact
125143

126144
- **Website**: [thirdweb.com](https://thirdweb.com)

0 commit comments

Comments
 (0)