@elizaos/plugin-web-search 0.1.8 → 0.25.6-alpha.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Shaw Walters, aka Moon aka @lalalune
+Copyright (c) 2025 Shaw Walters, aka Moon aka @lalalune
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.MD

@@ -28,7 +28,7 @@ TAVILY_API_KEY=your_api_key    # Required: API key for search service
 
 ## Usage
 
-Import and register the plugin in your Eliza configuration:
+Import and register the plugin in your Eliza configuration.
 
 ```typescript
 import { webSearchPlugin } from "@elizaos/plugin-web-search";
@@ -39,6 +39,28 @@ export default {
 };
 ```
 
+**Custom Usage**
+If you want custom usage, for example, twitter-client to search the web before posting a tweet, you can also import the webSearchService and use it directly. Here's how you can do it:
+
+```typescript
+// packages/client-twitter/src/post.ts
+const webSearchService = new WebSearchService();
+await webSearchService.initialize(runtime);
+const latestNews = await webSearchService.search(
+    "latest news on AI Agents",
+    // searchOptions
+);
+
+const state = await this.runtime.composeState(
+    {  } // memory,
+    { // additional keys
+        latestNews: latestNews,
+    }
+);
+
+// Then modify the tweet template to include the {{latestNews}} and however you need
+```
+
 ## Features
 
 ### Web Search